com.esri.arcgis.gisclient
Class AGSServerConnectionName

java.lang.Object
  extended by com.esri.arcgis.gisclient.AGSServerConnectionName
All Implemented Interfaces:
IAGSServerConnectionName, IAGSServerConnectionName2, com.esri.arcgis.interop.RemoteObjRef, IName, IPersist, IPersistStream, java.io.Externalizable, java.io.Serializable

public class AGSServerConnectionName
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IAGSServerConnectionName, IAGSServerConnectionName2, IName, IPersistStream, java.io.Externalizable

COM Class 'AGSServerConnectionName'. Generated 3/19/2015 1:20:47 PM from 'C:\ArcGIS\COM\esriGISClient.olb'

Description 'A name object for ArcGIS Server Connections.' 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
static long serialVersionUID
           
 
Fields inherited from interface com.esri.arcgis.gisclient.IAGSServerConnectionName2
IID, IIDc65dc76b_b454_4b35_83ec_e9082b57a56f, xxDummy
 
Fields inherited from interface com.esri.arcgis.gisclient.IAGSServerConnectionName
IID298cce6a_4d86_40ee_8f4a_bebc419b9a4d
 
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
AGSServerConnectionName()
          Constructs a AGSServerConnectionName using ArcGIS Engine.
AGSServerConnectionName(java.lang.Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
AGSServerConnectionName theAGSServerConnectionName = (AGSServerConnectionName) obj;
 
Method Summary
 boolean equals(java.lang.Object o)
          Compare this object with another
 void getClassID(GUID[] pClassID)
          getClassID
static java.lang.String getClsid()
          getClsid.
 IPropertySet getConnectionProperties()
          The connection properties of the AGSServerConnectionName.
 java.lang.String getConnectionString()
          The connection properties of the GIS server connection.
 int getConnectionType()
          The type of the associated GIS server connection.
 com.esri.arcgis.interop.Dispatch getJintegraDispatch()
          Deprecated. Internal use only.
 java.lang.String getNameString()
          The name string of the object.
 java.lang.String getServerConnectionFactoryProgID()
          The programmatic ID of the server connection factory.
 void getSizeMax(_ULARGE_INTEGER[] pcbSize)
          getSizeMax
 int hashCode()
          the hashcode for this object
 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 a AGSServerConnectionName.
 void save(IStream pstm, int fClearDirty)
          save
 void setConnectionProperties(IPropertySet ppConnProps)
          The connection properties of the AGSServerConnectionName.
 void setConnectionString(java.lang.String connString)
          The connection properties of the GIS server connection.
 void setNameString(java.lang.String nameString)
          The name string of the object.
 void setServerConnectionFactoryProgID(java.lang.String progID)
          The programmatic ID of the server connection factory.
 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

AGSServerConnectionName

public AGSServerConnectionName()
                        throws java.io.IOException,
                               java.net.UnknownHostException
Constructs a AGSServerConnectionName using ArcGIS Engine.

Throws:
java.io.IOException - if there are interop problems
java.net.UnknownHostException - if there are interop problems

AGSServerConnectionName

public AGSServerConnectionName(java.lang.Object obj)
                        throws java.io.IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
AGSServerConnectionName theAGSServerConnectionName = (AGSServerConnectionName) obj;

Construct a AGSServerConnectionName using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to AGSServerConnectionName.

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()
Deprecated. Internal use only.

Specified by:
getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

release

public void release()
Release a AGSServerConnectionName.

Specified by:
release in interface com.esri.arcgis.interop.RemoteObjRef

setConnectionProperties

public void setConnectionProperties(IPropertySet ppConnProps)
                             throws java.io.IOException,
                                    AutomationException
The connection properties of the AGSServerConnectionName.

Specified by:
setConnectionProperties in interface IAGSServerConnectionName
Parameters:
ppConnProps - 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.

getConnectionProperties

public IPropertySet getConnectionProperties()
                                     throws java.io.IOException,
                                            AutomationException
The connection properties of the AGSServerConnectionName.

Specified by:
getConnectionProperties in interface IAGSServerConnectionName
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.

getConnectionType

public int getConnectionType()
                      throws java.io.IOException,
                             AutomationException
The type of the associated GIS server connection.

Specified by:
getConnectionType in interface IAGSServerConnectionName
Returns:
A com.esri.arcgis.gisclient.esriAGSConnectionType constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getConnectionString

public java.lang.String getConnectionString()
                                     throws java.io.IOException,
                                            AutomationException
The connection properties of the GIS server connection.

Specified by:
getConnectionString in interface IAGSServerConnectionName2
Returns:
The connString
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setConnectionString

public void setConnectionString(java.lang.String connString)
                         throws java.io.IOException,
                                AutomationException
The connection properties of the GIS server connection.

Specified by:
setConnectionString in interface IAGSServerConnectionName2
Parameters:
connString - The connString (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getServerConnectionFactoryProgID

public java.lang.String getServerConnectionFactoryProgID()
                                                  throws java.io.IOException,
                                                         AutomationException
The programmatic ID of the server connection factory.

Specified by:
getServerConnectionFactoryProgID in interface IAGSServerConnectionName2
Returns:
The progID
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setServerConnectionFactoryProgID

public void setServerConnectionFactoryProgID(java.lang.String progID)
                                      throws java.io.IOException,
                                             AutomationException
The programmatic ID of the server connection factory.

Specified by:
setServerConnectionFactoryProgID in interface IAGSServerConnectionName2
Parameters:
progID - The progID (in)
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.

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