com.esri.arcgis.gisclient
Class AGSServerObjectName

java.lang.Object
  com.esri.arcgis.gisclient.AGSServerObjectName

All Implemented Interfaces:

IAGSServerObjectName, IAGSServerObjectName2, IName, IPersist, IPersistStream, java.io.Serializable

public class AGSServerObjectName

extends java.lang.Object

implements IAGSServerObjectName, IAGSServerObjectName2, IName, IPersistStream

A name object for ArcGIS Server Objects.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Remarks

The name object for an MapServer or GeocodeServer server object obtained through an AGSServerConnection. An application can call the Open method on the AGSServerObjectName in order to connect to and get an object reference to the MapServer or GeocodeServer object.

See Also:

AGSServerConnection, MapServer, GeocodeServer, Serialized Form

Constructor Summary

AGSServerObjectName()
Constructs a AGSServerObjectName using ArcGIS Engine.

AGSServerObjectName(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.

Method Summary

boolean	equals(java.lang.Object o) Compare this object with another
IAGSServerConnectionName	getAGSServerConnectionName() The connection name object for this server object.
IAGSServerObjectName	getAsIAGSServerObjectName() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IAGSServerObjectName2	getAsIAGSServerObjectName2() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IName	getAsIName() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IPersistStream	getAsIPersistStream() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
java.lang.String	getCapabilities() The web capabilities of the service.
void	getClassID(GUID[] pClassID) Supported Platforms
static java.lang.String	getClsid()
java.lang.String	getName() Name of the server object.
java.lang.String	getNameString() The name string of the object.
java.lang.String	getNameString2() The name string for the server object name.
java.lang.String	getParentType() The type of server object this server object extension is associated with.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) Supported Platforms
java.lang.String	getType() Type of the server object (MapServer or GeocodeServer).
java.lang.String	getURL() Server object URL (if connection type is internet).
int	hashCode() the hashcode for this object
void	isDirty() Supported Platforms
void	load(IStream pstm) Supported Platforms
java.lang.Object	open() Opens the object referred to by this name.
void	save(IStream pstm, int fClearDirty) Supported Platforms
void	setAGSServerConnectionNameByRef(IAGSServerConnectionName ppServerConnName) The connection name object for this server object.
void	setCapabilities(java.lang.String caps) The web capabilities of the service.
void	setName(java.lang.String objectName) Name of the server object.
void	setNameString(java.lang.String nameString) The name string of the object.
void	setNameString2(java.lang.String ns) The name string for the server object name.
void	setParentType(java.lang.String parentType) The type of server object this server object extension is associated with.
void	setType(java.lang.String objectType) Type of the server object (MapServer or GeocodeServer).
void	setURL(java.lang.String objectURL) Server object URL (if connection type is internet).

Methods inherited from class java.lang.Object

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

Constructor Detail

AGSServerObjectName

public AGSServerObjectName()
                    throws java.io.IOException,
                           java.net.UnknownHostException

Constructs a AGSServerObjectName using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

AGSServerObjectName

public AGSServerObjectName(java.lang.Object obj)
                    throws java.io.IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.

Construct a AGSServerObjectName using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to AGSServerObjectName.
AGSServerObjectName theAGSServerObjectName = (AGSServerObjectName) obj;

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems

Method Detail

getClsid

public static java.lang.String getClsid()

getAsIAGSServerObjectName

public IAGSServerObjectName getAsIAGSServerObjectName()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIAGSServerObjectName2

public IAGSServerObjectName2 getAsIAGSServerObjectName2()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIName

public IName getAsIName()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIPersistStream

public IPersistStream getAsIPersistStream()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

hashCode

public int hashCode()

the hashcode for this object

setName

public void setName(java.lang.String objectName)
             throws java.io.IOException,
                    AutomationException

Description copied from interface: IAGSServerObjectName

Name of the server object.

Supported Platforms

Windows, Solaris, Linux

Remarks

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

Specified by:

setName in interface IAGSServerObjectName

Parameters:

objectName - The objectName (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

getName

public java.lang.String getName()
                         throws java.io.IOException,
                                AutomationException

Description copied from interface: IAGSServerObjectName

Name of the server object.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getName in interface IAGSServerObjectName

Returns:

The objectName

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setType

public void setType(java.lang.String objectType)
             throws java.io.IOException,
                    AutomationException

Description copied from interface: IAGSServerObjectName

Type of the server object (MapServer or GeocodeServer).

Supported Platforms

Windows, Solaris, Linux

Specified by:

setType in interface IAGSServerObjectName

Parameters:

objectType - The objectType (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getType

public java.lang.String getType()
                         throws java.io.IOException,
                                AutomationException

Description copied from interface: IAGSServerObjectName

Type of the server object (MapServer or GeocodeServer).

Supported Platforms

Windows, Solaris, Linux

Specified by:

getType in interface IAGSServerObjectName

Returns:

The objectType

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

setURL

public void setURL(java.lang.String objectURL)
            throws java.io.IOException,
                   AutomationException

Description copied from interface: IAGSServerObjectName

Server object URL (if connection type is internet).

Supported Platforms

Windows, Solaris, Linux

Remarks

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

Specified by:

setURL in interface IAGSServerObjectName

Parameters:

objectURL - The objectURL (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

getURL

public java.lang.String getURL()
                        throws java.io.IOException,
                               AutomationException

Description copied from interface: IAGSServerObjectName

Server object URL (if connection type is internet).

Supported Platforms

Windows, Solaris, Linux

Specified by:

getURL in interface IAGSServerObjectName

Returns:

The objectURL

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAGSServerConnectionName

public IAGSServerConnectionName getAGSServerConnectionName()
                                                    throws java.io.IOException,
                                                           AutomationException

Description copied from interface: IAGSServerObjectName

The connection name object for this server object.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getAGSServerConnectionName in interface IAGSServerObjectName

Returns:

A reference to a com.esri.arcgis.gisclient.IAGSServerConnectionName

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

setAGSServerConnectionNameByRef

public void setAGSServerConnectionNameByRef(IAGSServerConnectionName ppServerConnName)
                                     throws java.io.IOException,
                                            AutomationException

Description copied from interface: IAGSServerObjectName

The connection name object for this server object.

Specified by:

setAGSServerConnectionNameByRef in interface IAGSServerObjectName

Parameters:

ppServerConnName - A reference to a com.esri.arcgis.gisclient.IAGSServerConnectionName (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setNameString2

public void setNameString2(java.lang.String ns)
                    throws java.io.IOException,
                           AutomationException

Description copied from interface: IAGSServerObjectName2

The name string for the server object name.

Specified by:

setNameString2 in interface IAGSServerObjectName2

Parameters:

ns - The ns (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNameString2

public java.lang.String getNameString2()
                                throws java.io.IOException,
                                       AutomationException

Description copied from interface: IAGSServerObjectName2

The name string for the server object name.

Specified by:

getNameString2 in interface IAGSServerObjectName2

Returns:

The ns

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setParentType

public void setParentType(java.lang.String parentType)
                   throws java.io.IOException,
                          AutomationException

Description copied from interface: IAGSServerObjectName2

The type of server object this server object extension is associated with.

Specified by:

setParentType in interface IAGSServerObjectName2

Parameters:

parentType - The parentType (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

getParentType

public java.lang.String getParentType()
                               throws java.io.IOException,
                                      AutomationException

Description copied from interface: IAGSServerObjectName2

The type of server object this server object extension is associated with.

Specified by:

getParentType in interface IAGSServerObjectName2

Returns:

The parentType

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCapabilities

public void setCapabilities(java.lang.String caps)
                     throws java.io.IOException,
                            AutomationException

Description copied from interface: IAGSServerObjectName2

The web capabilities of the service.

Specified by:

setCapabilities in interface IAGSServerObjectName2

Parameters:

caps - The caps (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

getCapabilities

public java.lang.String getCapabilities()
                                 throws java.io.IOException,
                                        AutomationException

Description copied from interface: IAGSServerObjectName2

The web capabilities of the service.

Specified by:

getCapabilities in interface IAGSServerObjectName2

Returns:

The caps

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

setNameString

public void setNameString(java.lang.String nameString)
                   throws java.io.IOException,
                          AutomationException

Description copied from interface: IName

The name string of the object.

Supported Platforms

Windows, Solaris, Linux

Remarks

The NameString property is reserved for future use. When implemented, it will return a string representation of the locational component of the name object that may be persisted by applications.

Specified by:

setNameString in interface IName

Parameters:

nameString - The nameString (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNameString

public java.lang.String getNameString()
                               throws java.io.IOException,
                                      AutomationException

Description copied from interface: IName

The name string of the object.

Supported Platforms

Windows, Solaris, Linux

Remarks

The NameString property is reserved for future use. When implemented, it will return a string representation of the locational component of the name object that may be persisted by applications.

Specified by:

getNameString in interface IName

Returns:

The nameString

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

open

public java.lang.Object open()
                      throws java.io.IOException,
                             AutomationException

Description copied from interface: IName

Opens the object referred to by this name.

Supported Platforms

Windows, Solaris, Linux

Remarks

The Open method lets you instantiate the actual object given the name object.

Note: Opening a feature class that participates in a topology or geometric network will also open all other feature classes participating in the topology or geometric network in memory.

Specified by:

open in interface IName

Returns:

A reference to another Object (IUnknown)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws java.io.IOException,
                    AutomationException

Description copied from interface: IPersistStream

Supported Platforms

Windows, Solaris, Linux

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Specified by:

isDirty in interface IPersistStream

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws java.io.IOException,
                 AutomationException

Description copied from interface: IPersistStream

Supported Platforms

Windows, Solaris, Linux

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Specified by:

load in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws java.io.IOException,
                 AutomationException

Description copied from interface: IPersistStream

Supported Platforms

Windows, Solaris, Linux

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Specified by:

save in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

fClearDirty - The fClearDirty (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws java.io.IOException,
                       AutomationException

Description copied from interface: IPersistStream

Supported Platforms

Windows, Solaris, Linux

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Specified by:

getSizeMax in interface IPersistStream

Parameters:

pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

getClassID

public void getClassID(GUID[] pClassID)
                throws java.io.IOException,
                       AutomationException

Description copied from interface: IPersist

Supported Platforms

Windows, Solaris, Linux

Description

IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.

Specified by:

getClassID in interface IPersist

Parameters:

pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.