com.esri.arcgis.gisclient

Class AGSServerObjectName

java.lang.Object

com.esri.arcgis.gisclient.AGSServerObjectName

All Implemented Interfaces:

IMetadata, IMetadataEdit, IAGSServerObjectName, IAGSServerObjectName2, IAGSServerObjectName3, com.esri.arcgis.interop.RemoteObjRef, IName, IPersist, IPersistStream, java.io.Externalizable, java.io.Serializable

public class AGSServerObjectName
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IAGSServerObjectName, IAGSServerObjectName2, IAGSServerObjectName3, IName, IMetadata, IMetadataEdit, IPersistStream, java.io.Externalizable

COM Class 'AGSServerObjectName'. Generated 9/21/2023 10:01:44 AM from 'X:\ArcGIS\com\server\esriGISClient.tlb'

Description 'A name object for ArcGIS Server Objects.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static long	serialVersionUID

Fields inherited from interface com.esri.arcgis.gisclient.IAGSServerObjectName3

IID, IID4b815919_7659_4a55_8608_26eb7d6b24f2, xxDummy

Fields inherited from interface com.esri.arcgis.gisclient.IAGSServerObjectName2

IID2f311f9a_50f9_45d4_9553_d781a08445e8

Fields inherited from interface com.esri.arcgis.gisclient.IAGSServerObjectName

IID436bd37c_fe61_4a2e_9d74_1ae6fc8d654d

Fields inherited from interface com.esri.arcgis.geodatabase.IMetadata

IID, IID5de04a82_24e4_11d3_a641_0008c7d3ae50, xxDummy

Fields inherited from interface com.esri.arcgis.geodatabase.IMetadataEdit

IID, IID97fdb978_62a4_49c5_8252_b07837b33ee9, xxDummy

Fields inherited from interface com.esri.arcgis.system.IPersistStream

IID, IID00000109_0000_0000_c000_000000000046, xxDummy

Fields inherited from interface com.esri.arcgis.system.IPersist

IID0000010c_0000_0000_c000_000000000046

Constructor Summary

Constructors

Constructor and Description
AGSServerObjectName() Constructs a AGSServerObjectName using ArcGIS Engine.
AGSServerObjectName(java.lang.Object obj) Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. AGSServerObjectName theAGSServerObjectName = (AGSServerObjectName) obj;

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o) Compare this object with another
IAGSServerConnectionName	getAGSServerConnectionName() The connection name object for this server object.
java.lang.String	getCapabilities() The web capabilities of the service.
void	getClassID(GUID[] pClassID) getClassID
static java.lang.String	getClsid() getClsid.
java.lang.String	getDescription() The name of the service.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Gets a reference to a com.esri.arcgis.interop.Dispatch which can be used to access the COM object that support for this interface indicates the implementing class references.
IPropertySet	getMetadata() The PropertySet containing metadata.
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) getSizeMax
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
boolean	isCanEditMetadata() Indicates if metadata can be edited.
void	isDirty() isDirty
void	load(IStream pstm) load
java.lang.Object	open() Opens the object referred to by this name.
void	readExternal(java.io.ObjectInput in)
void	release() Release this COM object reference
void	save(IStream pstm, int fClearDirty) save
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	setDescription(java.lang.String objectURL) The name of the service.
void	setMetadata(IPropertySet propertySet) The PropertySet containing metadata.
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).
void	synchronize(int action, int interval) Updates metadata with the current properties; may create metadata if it doesn't already exist.
void	writeExternal(java.io.ObjectOutput out)

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

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.
AGSServerObjectName theAGSServerObjectName = (AGSServerObjectName) obj;

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.

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()

getClsid.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()

Gets a reference to a com.esri.arcgis.interop.Dispatch which can be used to access the COM object that support for this interface indicates the implementing class references.

Specified by:

getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

Returns:

the COM object reference

release

public void release()

Release this COM object reference

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

setName

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

Name of the server object.

Specified by:

setName in interface IAGSServerObjectName

Parameters:

objectName - The objectName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getName

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

Name of the server object.

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

Type of the server object (MapServer or GeocodeServer).

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

Type of the server object (MapServer or GeocodeServer).

Specified by:

getType in interface IAGSServerObjectName

Returns:

The objectType

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setURL

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

Server object URL (if connection type is internet).

Specified by:

setURL in interface IAGSServerObjectName

Parameters:

objectURL - The objectURL (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getURL

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

Server object URL (if connection type is internet).

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

The connection name object for this server object.

Specified by:

getAGSServerConnectionName in interface IAGSServerObjectName

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setAGSServerConnectionNameByRef

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

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

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

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

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

Specified by:

setParentType in interface IAGSServerObjectName2

Parameters:

parentType - The parentType (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getParentType

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

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

The web capabilities of the service.

Specified by:

setCapabilities in interface IAGSServerObjectName2

Parameters:

caps - The caps (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCapabilities

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

The web capabilities of the service.

Specified by:

getCapabilities in interface IAGSServerObjectName2

Returns:

The caps

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDescription

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

The name of the service.

Specified by:

setDescription in interface IAGSServerObjectName3

Parameters:

objectURL - The objectURL (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDescription

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

The name of the service.

Specified by:

getDescription in interface IAGSServerObjectName3

Returns:

The objectURL

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setNameString

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

The name string of the object.

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

The name string of the object.

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

Opens the object referred to by this name.

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.

Example:

IName   pName = pFeatureClassName; 
pFeatureClass = new IFeatureClassProxy(pName.open());

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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.

getMetadata

public IPropertySet getMetadata()
                         throws java.io.IOException,
                                AutomationException

The PropertySet containing metadata.

Specified by:

getMetadata in interface IMetadata

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMetadata

public void setMetadata(IPropertySet propertySet)
                 throws java.io.IOException,
                        AutomationException

The PropertySet containing metadata.

Specified by:

setMetadata in interface IMetadata

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

synchronize

public void synchronize(int action,
                        int interval)
                 throws java.io.IOException,
                        AutomationException

Updates metadata with the current properties; may create metadata if it doesn't already exist.

Specified by:

synchronize in interface IMetadata

Parameters:

action - A com.esri.arcgis.geodatabase.esriMetadataSyncAction constant (in)

interval - The interval (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isCanEditMetadata

public boolean isCanEditMetadata()
                          throws java.io.IOException,
                                 AutomationException

Indicates if metadata can be edited.

Specified by:

isCanEditMetadata in interface IMetadataEdit

Returns:

The canEdit

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

isDirty

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

load

Specified by:

load in interface IPersistStream

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

save

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

save

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

getSizeMax

Specified by:

getSizeMax in interface IPersistStream

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getClassID

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

getClassID

Specified by:

getClassID in interface IPersist

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Specified by:

writeExternal in interface java.io.Externalizable

Throws:

java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Specified by:

readExternal in interface java.io.Externalizable

Throws:

java.io.IOException

java.lang.ClassNotFoundException