com.esri.arcgis.server
Class ServerObjectType

java.lang.Object
  com.esri.arcgis.server.ServerObjectType

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, IServerObjectType, IServerObjectType2, IServerObjectType3, IServerObjectType4, Serializable

public class ServerObjectType
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IServerObjectType, IServerObjectType2, IServerObjectType3, IServerObjectType4

The ServerObjectType object which defines the properties and behavior for server object types supported by the GIS server.

Remarks

Server objects may have extensions that extend their base functionality for more specialized uses. Each type of server object may have a set of extensions that can be enabled or disabled based on its configuration. ArcGIS for Server includes some server object extensions out of the box, and developers can extend ArcGIS for Server by writing their own server object extensions.

A ServerObjectExtensionType is the type of object extension. The types of server object extensions and the types of server objects they can extend is one of a defined set of server object extension types that a GIS server can support. The server object extensions enabled for a particular server object coniguration define the types of server object extension instances that a particular server object configuration starts up and provides to applications to use.

The ServerObjectExtensionType also defines the set of properties associated with a particular server object configuration that must be specified when creating the configuration. You must be connected to the GIS server as an administrator to access ServerType objects. A subset of properties of a ServerObjectExtensionType are available to non administators via the ServerObjectExtensionTypeInfo object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:

ServerObjectManager, ServerObjectType, IAGSServerConnectionAdmin, AGSServerConnectionName, IEnumServerObjectType, IEnumServerDirectory, AGSServerConnection, IServerConnection, AGSLocatorWorkspace, ServerObjectTypeInfo, IEnumServerObjectTypeInfo, IAGSServerObject, GeocodeServer, ServerDirectoryInfo, ServerObjectConfiguration, ServerContext, ServerObjectConfigurationStatus, IAGSServerObjectName, ServerConnection, ILocatorManager2.getAGSLocatorWorkspace(com.esri.arcgis.gisclient.IAGSServerConnectionName), IAGSServerConnectionName, IAGSEnumServerObjectName, ServerObject, IServerObjectConfigurationInfo, IServerObjectAdmin, AGSServerConnectionFactory, IAGSServerConnectionFactory, IEnumServerObjectConfigurationInfo, ILocatorWorkspaceName2.getAGSServerConnectionName(), IGISServerConnection, IAGSServerConnection, IServerContext, ServerDirectory, ServerObjectConfigurationInfo, IEnumServerMachine, ServerMachine, IServerObjectConfiguration, IServerObjectManager, IServerObjectTypeInfo, IServerMachine, IServerObject, IServerObjectType, AGSAddressLocator, GISServerConnection, AGSServerObjectName, ServerObjectAdmin, IEnumServerObjectConfiguration, Serialized Form

Constructor Summary

ServerObjectType(Object obj)
Construct a ServerObjectType using a reference to such an object returned from ArcGIS Engine or Server.

Method Summary

boolean	equals(Object o) Compare this object with another
String	getCLSID() The GUID of the COM class corresponding to the server object type.
int	getConfigurationsLimit() Limits the number of configurations that can be created of this server object type.
String	getDescription() Description of the server object type.
String	getDisplayName() Display name of the server object type.
IPropertySet	getInfo() Auxiliary information for the server objects type.
int	getIsolationLevel() The isolation level of the server objects supported by the server object type.
String	getName() Name of the server object type.
int	hashCode() the hashcode for this object
void	setCLSID(String pVal) The GUID of the COM class corresponding to the server object type.
void	setConfigurationsLimit(int pVal) Limits the number of configurations that can be created of this server object type.
void	setDescription(String desc) Description of the server object type.
void	setDisplayName(String pVal) Display name of the server object type.
void	setInfoByRef(IPropertySet props) Auxiliary information for the server objects type.
void	setIsolationLevel(int isoLevel) The isolation level of the server objects supported by the server object type.
void	setName(String pVal) Name of the server object type.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

ServerObjectType

public ServerObjectType(Object obj)
                 throws IOException

Construct a ServerObjectType using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to ServerObjectType.
Casting to this class from the return value of a method will not work, as this class represents an abstract class in ArcObjects.
*
ServerObjectType o = (ServerObjectType)obj; // will not work

ServerObjectType o = new ServerObjectType(obj); // Use this constructor instead
* @param obj an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems ServerObjectType theServerObjectType = (ServerObjectType) obj;

Method Detail

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

getName

public 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

Specified by:

getName in interface IServerObjectType

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setName

public 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

Specified by:

setName in interface IServerObjectType

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDescription

public 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

Specified by:

getDescription in interface IServerObjectType

Returns:

The desc

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDescription

public 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

Specified by:

setDescription in interface IServerObjectType

Parameters:

desc - The desc (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCLSID

public 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

Specified by:

getCLSID in interface IServerObjectType

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCLSID

public 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

Specified by:

setCLSID in interface IServerObjectType

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getIsolationLevel

public int getIsolationLevel()
                      throws IOException,
                             AutomationException

The isolation level of the server objects supported by the server object type.

Product Availability

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

Specified by:

getIsolationLevel in interface IServerObjectType2

Returns:

A com.esri.arcgis.server.esriServerIsolationLevel constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIsolationLevel

public void setIsolationLevel(int isoLevel)
                       throws IOException,
                              AutomationException

The isolation level of the server objects supported by the server object type.

Product Availability

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

Specified by:

setIsolationLevel in interface IServerObjectType2

Parameters:

isoLevel - A com.esri.arcgis.server.esriServerIsolationLevel constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDisplayName

public String getDisplayName()
                      throws IOException,
                             AutomationException

Display name of the server object type.

Product Availability

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

Specified by:

getDisplayName in interface IServerObjectType2

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDisplayName

public void setDisplayName(String pVal)
                    throws IOException,
                           AutomationException

Display name of the server object type.

Product Availability

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

Specified by:

setDisplayName in interface IServerObjectType2

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getConfigurationsLimit

public int getConfigurationsLimit()
                           throws IOException,
                                  AutomationException

Limits the number of configurations that can be created of this server object type.

Product Availability

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

Specified by:

getConfigurationsLimit in interface IServerObjectType3

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setConfigurationsLimit

public void setConfigurationsLimit(int pVal)
                            throws IOException,
                                   AutomationException

Limits the number of configurations that can be created of this server object type.

Product Availability

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

Specified by:

setConfigurationsLimit in interface IServerObjectType3

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setInfoByRef

public void setInfoByRef(IPropertySet props)
                  throws IOException,
                         AutomationException

Auxiliary information for the server objects type.

Product Availability

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

Specified by:

setInfoByRef in interface IServerObjectType4

Parameters:

props - A reference to a com.esri.arcgis.system.IPropertySet (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getInfo

public IPropertySet getInfo()
                     throws IOException,
                            AutomationException

Auxiliary information for the server objects type.

Product Availability

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

Specified by:

getInfo in interface IServerObjectType4

Returns:

A reference to a com.esri.arcgis.system.IPropertySet

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.