com.esri.arcgis.server
Interface IServerObjectType

All Superinterfaces:
Serializable
All Known Subinterfaces:
IServerObjectType2, IServerObjectType3
All Known Implementing Classes:
IServerObjectType2Proxy, IServerObjectType3Proxy, IServerObjectTypeProxy, ServerObjectType

public interface IServerObjectType
extends Serializable

Provides access to methods, for administrators, that control the behavior and properties of a server object type.

Remarks

The ArcGIS Server manages a set of server objects running across one or more host (container) machines. How those server objects are configured and run is defined by a set of server object configurations. Server object configurations can be added, removed and modified by users or developers who are members of the agsadmin users group, and therfore have administrator priviliges on the ArcGIS Server.

The types of server object configurations, and therefore server objects that can be created on a GIS server is one of a defined set of server object types that a GIS server can support. By default, the supported types are MapServer, GeocodeServer, GeoDataServer, GlobeServer and GPServer. The server object configuration type defines the types of server object instances that a particular server object configuration starts up and provides to applications to make use of.

The type also defines the set of properties associated with a particular server object configuration that must be specified when creating the configuration. For example, a MapServer requires a map document, a GeocodeServer requires a locator, etc

The IServerObjectType interface is a read/write interface on a server object type that allows administrators to configure new server object types to add to the server, update existing server object types, and to view the properties of a server object type.

Users and developers that are not part the the agsadmin group do not have access to this interface. An additional read only interface called IServerObjectTypeInfo is available to non-administrators which provides read only access to a subset of the server object type's properties.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux


Method Summary
 String getCLSID()
          The GUID of the COM class corresponding to the server object type.
 String getDescription()
          Description of the server object type.
 String getName()
          Name of the server object type.
 void setCLSID(String pVal)
          The GUID of the COM class corresponding to the server object type.
 void setDescription(String desc)
          Description of the server object type.
 void setName(String pVal)
          Name of the server object type.
 

Method Detail

getName

String getName()
               throws IOException,
                      AutomationException
Name of the server object type.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setName

void setName(String pVal)
             throws IOException,
                    AutomationException
Name of the server object type.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:
pVal - The pVal (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDescription

String getDescription()
                      throws IOException,
                             AutomationException
Description of the server object type.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:
The desc
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDescription

void setDescription(String desc)
                    throws IOException,
                           AutomationException
Description of the server object type.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:
desc - The desc (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCLSID

String getCLSID()
                throws IOException,
                       AutomationException
The GUID of the COM class corresponding to the server object type.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCLSID

void setCLSID(String pVal)
              throws IOException,
                     AutomationException
The GUID of the COM class corresponding to the server object type.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:
pVal - The pVal (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.