com.esri.arcgis.gisclient
Class IMSServiceName

java.lang.Object
  extended by com.esri.arcgis.gisclient.IMSServiceName
All Implemented Interfaces:
IMetadata, IMetadataEdit, IIMSAxlRequest, IIMSServiceDescription, IIMSUserRole, com.esri.arcgis.interop.RemoteObjRef, IName, IPersist, IPersistStream, ITestConnection, java.io.Externalizable, java.io.Serializable

public class IMSServiceName
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IIMSServiceDescription, IIMSAxlRequest, IName, IPersist, IPersistStream, IMetadata, IMetadataEdit, IIMSUserRole, ITestConnection, java.io.Externalizable

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

Description 'The IMS Service Name.' 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.IIMSServiceDescription
IID, IIDfe9f959a_06b5_4d52_8148_3bd33c29c0c5, xxDummy
 
Fields inherited from interface com.esri.arcgis.gisclient.IIMSAxlRequest
IID, IID2844f4ef_098f_4858_80a6_b6a29eb5f140, 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
 
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.gisclient.IIMSUserRole
IID, IID448631a6_2bda_4f54_a341_76cc7ffd70a7, xxDummy
 
Fields inherited from interface com.esri.arcgis.system.ITestConnection
IID, IID6b61d022_cae6_41a9_bd13_6dac82cffefd, xxDummy
 
Constructor Summary
IMSServiceName()
          Constructs a IMSServiceName using ArcGIS Engine.
IMSServiceName(java.lang.Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
IMSServiceName theIMSServiceName = (IMSServiceName) 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()
          True if the service is free.
 com.esri.arcgis.interop.Dispatch getJintegraDispatch()
          Deprecated. Internal use only.
 IPropertySet getMetadata()
          The PropertySet containing metadata.
 java.lang.String getName()
          Service Name.
 java.lang.String getNameString()
          The name string of the object.
 java.lang.Object getPassword()
          Password for the specified service.
 int getSecurity()
          Type of security set on the service.
 java.lang.String getServerVersion(ITrackCancel trackCancel, boolean showConnectingAVI, boolean processMessages)
          The ArcIMS server version.
 int getServiceType()
          Type of service.
 void getSizeMax(_ULARGE_INTEGER[] pcbSize)
          getSizeMax
 java.lang.String getURL()
          URL to ArcIMS server.
 java.lang.String getUserName()
          User name for the specified service.
 int getUserRole()
          User role.
 int hashCode()
          the hashcode for this object
 boolean isCanEditMetadata()
          Indicates if metadata can be edited.
 void isDirty()
          isDirty
 boolean isPrivate()
          Indicates if the service is private (requires password).
 boolean isSavePassword()
          Indicates if the password should be saved.
 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 IMSServiceName.
 void save(IStream pstm, int fClearDirty)
          save
 java.lang.String sendAxlRequest(java.lang.String axl, boolean queryRequest, ITrackCancel trackCancel, boolean showConnectingAVI, boolean processMessages)
          Sends an Axl request.
 IStream sendAxlRequestStream(java.lang.String axl, boolean queryRequest, ITrackCancel trackCancel, boolean showConnectingAVI, boolean processMessages)
          Sends an Axl request and returns a stream.
 java.lang.String sendCommandRequest(java.lang.String command, ITrackCancel trackCancel, boolean showConnectingAVI, boolean processMessages)
          Sends a command request,i.e.: ConnectorPing.
 void setConnectionProperties(IPropertySet connectionProperties)
          True if the service is free.
 void setIsPrivate(boolean isPrivate)
          Indicates if the service is private (requires password).
 void setMetadata(IPropertySet propertySet)
          The PropertySet containing metadata.
 void setName(java.lang.String name)
          Service Name.
 void setNameString(java.lang.String nameString)
          The name string of the object.
 void setPassword(java.lang.String password)
          Password for the specified service.
 void setSavePassword(boolean flag)
          Indicates if the password should be saved.
 void setSecurity(int security)
          Type of security set on the service.
 void setServiceType(int type)
          Type of service.
 void setURL(java.lang.String uRL)
          URL to ArcIMS server.
 void setUserName(java.lang.String userName)
          User name for the specified service.
 void setUserRole(int role)
          User role.
 void synchronize(int action, int interval)
          Updates metadata with the current properties; may create metadata if it doesn't already exist.
 boolean testConnection()
          Tests if the connection is successful with the current configuration.
 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

IMSServiceName

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

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

IMSServiceName

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

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

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 IMSServiceName.

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

getName

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

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

setName

public void setName(java.lang.String name)
             throws java.io.IOException,
                    AutomationException
Service Name.

Specified by:
setName in interface IIMSServiceDescription
Parameters:
name - The name (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
URL to ArcIMS server.

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

setURL

public void setURL(java.lang.String uRL)
            throws java.io.IOException,
                   AutomationException
URL to ArcIMS server.

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

setUserName

public void setUserName(java.lang.String userName)
                 throws java.io.IOException,
                        AutomationException
User name for the specified service.

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

getUserName

public java.lang.String getUserName()
                             throws java.io.IOException,
                                    AutomationException
User name for the specified service.

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

getPassword

public java.lang.Object getPassword()
                             throws java.io.IOException,
                                    AutomationException
Password for the specified service.

Specified by:
getPassword in interface IIMSServiceDescription
Returns:
A Variant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPassword

public void setPassword(java.lang.String password)
                 throws java.io.IOException,
                        AutomationException
Password for the specified service.

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

isSavePassword

public boolean isSavePassword()
                       throws java.io.IOException,
                              AutomationException
Indicates if the password should be saved.

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

setSavePassword

public void setSavePassword(boolean flag)
                     throws java.io.IOException,
                            AutomationException
Indicates if the password should be saved.

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

getServiceType

public int getServiceType()
                   throws java.io.IOException,
                          AutomationException
Type of service.

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

setServiceType

public void setServiceType(int type)
                    throws java.io.IOException,
                           AutomationException
Type of service.

Specified by:
setServiceType in interface IIMSServiceDescription
Parameters:
type - A com.esri.arcgis.gisclient.acServiceType constant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSecurity

public int getSecurity()
                throws java.io.IOException,
                       AutomationException
Type of security set on the service. Use a combination of acSecurityType constants.

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

setSecurity

public void setSecurity(int security)
                 throws java.io.IOException,
                        AutomationException
Type of security set on the service. Use a combination of acSecurityType constants.

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

isPrivate

public boolean isPrivate()
                  throws java.io.IOException,
                         AutomationException
Indicates if the service is private (requires password).

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

setIsPrivate

public void setIsPrivate(boolean isPrivate)
                  throws java.io.IOException,
                         AutomationException
Indicates if the service is private (requires password).

Specified by:
setIsPrivate in interface IIMSServiceDescription
Parameters:
isPrivate - The isPrivate (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
True if the service is free.

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

setConnectionProperties

public void setConnectionProperties(IPropertySet connectionProperties)
                             throws java.io.IOException,
                                    AutomationException
True if the service is free.

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

sendAxlRequest

public java.lang.String sendAxlRequest(java.lang.String axl,
                                       boolean queryRequest,
                                       ITrackCancel trackCancel,
                                       boolean showConnectingAVI,
                                       boolean processMessages)
                                throws java.io.IOException,
                                       AutomationException
Sends an Axl request.

Specified by:
sendAxlRequest in interface IIMSAxlRequest
Parameters:
axl - The axl (in)
queryRequest - The queryRequest (in)
trackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)
showConnectingAVI - The showConnectingAVI (in)
processMessages - The processMessages (in)
Returns:
The response
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

sendAxlRequestStream

public IStream sendAxlRequestStream(java.lang.String axl,
                                    boolean queryRequest,
                                    ITrackCancel trackCancel,
                                    boolean showConnectingAVI,
                                    boolean processMessages)
                             throws java.io.IOException,
                                    AutomationException
Sends an Axl request and returns a stream.

Specified by:
sendAxlRequestStream in interface IIMSAxlRequest
Parameters:
axl - The axl (in)
queryRequest - The queryRequest (in)
trackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)
showConnectingAVI - The showConnectingAVI (in)
processMessages - The processMessages (in)
Returns:
A reference to a com.esri.arcgis.system.IStream
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

sendCommandRequest

public java.lang.String sendCommandRequest(java.lang.String command,
                                           ITrackCancel trackCancel,
                                           boolean showConnectingAVI,
                                           boolean processMessages)
                                    throws java.io.IOException,
                                           AutomationException
Sends a command request,i.e.: ConnectorPing.

Specified by:
sendCommandRequest in interface IIMSAxlRequest
Parameters:
command - The command (in)
trackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)
showConnectingAVI - The showConnectingAVI (in)
processMessages - The processMessages (in)
Returns:
The response
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getServerVersion

public java.lang.String getServerVersion(ITrackCancel trackCancel,
                                         boolean showConnectingAVI,
                                         boolean processMessages)
                                  throws java.io.IOException,
                                         AutomationException
The ArcIMS server version.

Specified by:
getServerVersion in interface IIMSAxlRequest
Parameters:
trackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)
showConnectingAVI - The showConnectingAVI (in)
processMessages - The processMessages (in)
Returns:
The serverVersion
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.

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.

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.

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.

getUserRole

public int getUserRole()
                throws java.io.IOException,
                       AutomationException
User role.

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

setUserRole

public void setUserRole(int role)
                 throws java.io.IOException,
                        AutomationException
User role.

Specified by:
setUserRole in interface IIMSUserRole
Parameters:
role - A com.esri.arcgis.gisclient.acUserRole constant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

testConnection

public boolean testConnection()
                       throws java.io.IOException,
                              AutomationException
Tests if the connection is successful with the current configuration.

Specified by:
testConnection in interface ITestConnection
Returns:
The successful
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