com.esri.arcgis.gisclient
Interface IAGSServerObjectName

All Superinterfaces:
Serializable
All Known Subinterfaces:
IAGSServerObjectName2, IAGSServerObjectName3
All Known Implementing Classes:
AGSServerObjectName

public interface IAGSServerObjectName
extends Serializable

Provides access to members that supply server object name information.

Superseded By

IAGSServerObjectName3

Remarks

The IAGSServerObjectName interface lets you access the properties of an AGSServerObjectName which is The name object for an MapServer or GeocodeServer server object obtained through an AGSServerConnection. IAGSServerObjectName has properties for the server object's Name, Type and if connecting to a web service catalog, the URL.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:
IEnumServerObjectType, AGSLocatorWorkspace, IEnumServerObjectTypeInfo, GeocodeServer, ILocatorManager2.getAGSLocatorWorkspace(com.esri.arcgis.gisclient.IAGSServerConnectionName), ServerObject, ILocatorWorkspaceName2.getAGSServerConnectionName(), AGSAddressLocator

Method Summary
 IAGSServerConnectionName getAGSServerConnectionName()
          The connection name object for this server object.
 String getName()
          Name of the server object.
 String getType()
          Type of the server object (MapServer or GeocodeServer).
 String getURL()
          Server object URL (if connection type is internet).
 void setAGSServerConnectionNameByRef(IAGSServerConnectionName ppServerConnName)
          The connection name object for this server object.
 void setName(String objectName)
          Name of the server object.
 void setType(String objectType)
          Type of the server object (MapServer or GeocodeServer).
 void setURL(String objectURL)
          Server object URL (if connection type is internet).
 

Method Detail

setName

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getName

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

Remarks

Required if the MapServer object is obtained via a LAN AGSServerConnection.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setType

void setType(String objectType)
             throws IOException,
                    AutomationException
Type of the server object (MapServer or GeocodeServer).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getType

String getType()
               throws IOException,
                      AutomationException
Type of the server object (MapServer or GeocodeServer).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setURL

void setURL(String objectURL)
            throws IOException,
                   AutomationException
Server object URL (if connection type is internet).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getURL

String getURL()
              throws IOException,
                     AutomationException
Server object URL (if connection type is internet).

Remarks

Required if the MapServer object is obtained via an internet AGSServerConnection to a web service catalog.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getAGSServerConnectionName

IAGSServerConnectionName getAGSServerConnectionName()
                                                    throws IOException,
                                                           AutomationException
The connection name object for this server object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
A reference to a com.esri.arcgis.gisclient.IAGSServerConnectionName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAGSServerConnectionNameByRef

void setAGSServerConnectionNameByRef(IAGSServerConnectionName ppServerConnName)
                                     throws IOException,
                                            AutomationException
The connection name object for this server object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
ppServerConnName - A reference to a com.esri.arcgis.gisclient.IAGSServerConnectionName (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.