com.esri.arcgis.catalog
Class IMSGlobeServiceDescription

java.lang.Object
  extended by com.esri.arcgis.catalog.IMSGlobeServiceDescription
All Implemented Interfaces:
IGxObject, IGxObjectContainer, IGxObjectUI, IIMSServiceDescription, IIMSUserRole, com.esri.arcgis.interop.RemoteObjRef, IName, java.io.Serializable

public class IMSGlobeServiceDescription
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IGxObject, IGxObjectUI, IIMSServiceDescription, IIMSUserRole, IGxObjectContainer, IName

COM Class 'IMSGlobeServiceDescription'. Generated 3/19/2015 1:20:49 PM from 'C:\ArcGIS\COM\esriCatalog.olb'

Description 'GxObject that represents ArcIMS Globe File.' 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 inherited from interface com.esri.arcgis.catalog.IGxObject
IID, IIDbdbbb3eb_d0b2_11d1_aed9_080009ec734b, xxDummy
 
Fields inherited from interface com.esri.arcgis.catalog.IGxObjectUI
IID, IID7273aa57_e6f9_11d2_9f30_00c04f6bc69e, xxDummy
 
Fields inherited from interface com.esri.arcgis.gisclient.IIMSServiceDescription
IID, IIDfe9f959a_06b5_4d52_8148_3bd33c29c0c5, xxDummy
 
Fields inherited from interface com.esri.arcgis.gisclient.IIMSUserRole
IID, IID448631a6_2bda_4f54_a341_76cc7ffd70a7, xxDummy
 
Fields inherited from interface com.esri.arcgis.catalog.IGxObjectContainer
IID, IID7273aa58_e6f9_11d2_9f30_00c04f6bc69e, xxDummy
 
Constructor Summary
IMSGlobeServiceDescription()
          Constructs a IMSGlobeServiceDescription using ArcGIS Engine.
IMSGlobeServiceDescription(java.lang.Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
IMSGlobeServiceDescription theIMSGlobeServiceDescription = (IMSGlobeServiceDescription) obj;
 
Method Summary
 IGxObject addChild(IGxObject child)
          Adds a new child and returns a reference to it.
 void attach(IGxObject parent, IGxCatalog pCatalog)
          Attaches the object to its parent and the catalog.
 void deleteChild(IGxObject child)
          Deletes the specified child object.
 void detach()
          Instructs the object to detach itself from its parent and the catalog.
 boolean equals(java.lang.Object o)
          Compare this object with another
 java.lang.String getBaseName()
          The base name of the object (i.e.
 java.lang.String getCategory()
          The category of the object.
 IEnumGxObject getChildren()
          An enumeration of the child objects.
 IUID getClassID()
          The class ID of this object.
static java.lang.String getClsid()
          getClsid.
 IPropertySet getConnectionProperties()
          True if the service is free.
 IUID getContextMenu()
          The class ID of the context menu for this object.
 java.lang.String getFullName()
          The full name of the object.
 IName getInternalObjectName()
          The Name for the internal object that this GxObject represents.
 com.esri.arcgis.interop.Dispatch getJintegraDispatch()
          Deprecated. Internal use only.
 int getLargeImage()
          The large image that represents the object.
 int getLargeSelectedImage()
          The large image that represents the object when it is selected.
 java.lang.String getName()
          The short name of the object.
 java.lang.String getNameString()
          The name string of the object.
 IUID getNewMenu()
          The class ID of the New menu for this object.
 IGxObject getParent()
          The parent of the object.
 java.lang.Object getPassword()
          Password for the specified service.
 int getSecurity()
          Type of security set on the service.
 int getServiceType()
          Type of service.
 int getSmallImage()
          The small image that represents the object.
 int getSmallSelectedImage()
          The small image that represents the object when it is selected.
 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 isAreChildrenViewable()
          Indicates if the objects children are available for viewing in the tree-view.
 boolean isHasChildren()
          Indicates if the object has any children.
 boolean isPrivate()
          Indicates if the service is private (requires password).
 boolean isSavePassword()
          Indicates if the password should be saved.
 boolean isValid()
          Indicates if the object is still valid.
 java.lang.Object open()
          Opens the object referred to by this name.
 void refresh()
          Updates the object and any children of the object.
 void release()
          Release a IMSGlobeServiceDescription.
 void setConnectionProperties(IPropertySet connectionProperties)
          True if the service is free.
 void setIsPrivate(boolean isPrivate)
          Indicates if the service is private (requires password).
 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.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

IMSGlobeServiceDescription

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

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

IMSGlobeServiceDescription

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

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

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

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

getName

public java.lang.String getName()
                         throws java.io.IOException,
                                AutomationException
The short name of the object.

Specified by:
getName in interface IGxObject
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.

getFullName

public java.lang.String getFullName()
                             throws java.io.IOException,
                                    AutomationException
The full name of the object.

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

getBaseName

public java.lang.String getBaseName()
                             throws java.io.IOException,
                                    AutomationException
The base name of the object (i.e. no extension).

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

getCategory

public java.lang.String getCategory()
                             throws java.io.IOException,
                                    AutomationException
The category of the object.

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

getParent

public IGxObject getParent()
                    throws java.io.IOException,
                           AutomationException
The parent of the object.

Specified by:
getParent in interface IGxObject
Returns:
A reference to a com.esri.arcgis.catalog.IGxObject
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getClassID

public IUID getClassID()
                throws java.io.IOException,
                       AutomationException
The class ID of this object.

Specified by:
getClassID in interface IGxObject
Returns:
A reference to a com.esri.arcgis.system.IUID
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getInternalObjectName

public IName getInternalObjectName()
                            throws java.io.IOException,
                                   AutomationException
The Name for the internal object that this GxObject represents.

Specified by:
getInternalObjectName in interface IGxObject
Returns:
A reference to a com.esri.arcgis.system.IName
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isValid

public boolean isValid()
                throws java.io.IOException,
                       AutomationException
Indicates if the object is still valid.

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

attach

public void attach(IGxObject parent,
                   IGxCatalog pCatalog)
            throws java.io.IOException,
                   AutomationException
Attaches the object to its parent and the catalog.

Specified by:
attach in interface IGxObject
Parameters:
parent - A reference to a com.esri.arcgis.catalog.IGxObject (in)
pCatalog - A reference to a com.esri.arcgis.catalog.IGxCatalog (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

detach

public void detach()
            throws java.io.IOException,
                   AutomationException
Instructs the object to detach itself from its parent and the catalog.

Specified by:
detach in interface IGxObject
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

refresh

public void refresh()
             throws java.io.IOException,
                    AutomationException
Updates the object and any children of the object.

Specified by:
refresh in interface IGxObject
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSmallImage

public int getSmallImage()
                  throws java.io.IOException,
                         AutomationException
The small image that represents the object.

Specified by:
getSmallImage in interface IGxObjectUI
Returns:
The hBitmap (A COM typedef)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSmallSelectedImage

public int getSmallSelectedImage()
                          throws java.io.IOException,
                                 AutomationException
The small image that represents the object when it is selected.

Specified by:
getSmallSelectedImage in interface IGxObjectUI
Returns:
The hBitmap (A COM typedef)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLargeImage

public int getLargeImage()
                  throws java.io.IOException,
                         AutomationException
The large image that represents the object.

Specified by:
getLargeImage in interface IGxObjectUI
Returns:
The hBitmap (A COM typedef)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLargeSelectedImage

public int getLargeSelectedImage()
                          throws java.io.IOException,
                                 AutomationException
The large image that represents the object when it is selected.

Specified by:
getLargeSelectedImage in interface IGxObjectUI
Returns:
The hBitmap (A COM typedef)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getContextMenu

public IUID getContextMenu()
                    throws java.io.IOException,
                           AutomationException
The class ID of the context menu for this object.

Specified by:
getContextMenu in interface IGxObjectUI
Returns:
A reference to a com.esri.arcgis.system.IUID
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getNewMenu

public IUID getNewMenu()
                throws java.io.IOException,
                       AutomationException
The class ID of the New menu for this object.

Specified by:
getNewMenu in interface IGxObjectUI
Returns:
A reference to a com.esri.arcgis.system.IUID
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.

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.

isHasChildren

public boolean isHasChildren()
                      throws java.io.IOException,
                             AutomationException
Indicates if the object has any children.

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

getChildren

public IEnumGxObject getChildren()
                          throws java.io.IOException,
                                 AutomationException
An enumeration of the child objects.

Specified by:
getChildren in interface IGxObjectContainer
Returns:
A reference to a com.esri.arcgis.catalog.IEnumGxObject
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isAreChildrenViewable

public boolean isAreChildrenViewable()
                              throws java.io.IOException,
                                     AutomationException
Indicates if the objects children are available for viewing in the tree-view.

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

addChild

public IGxObject addChild(IGxObject child)
                   throws java.io.IOException,
                          AutomationException
Adds a new child and returns a reference to it. However, if a duplicate already exists, the function returns the existing child instead.

Specified by:
addChild in interface IGxObjectContainer
Parameters:
child - A reference to a com.esri.arcgis.catalog.IGxObject (in)
Returns:
A reference to a com.esri.arcgis.catalog.IGxObject
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

deleteChild

public void deleteChild(IGxObject child)
                 throws java.io.IOException,
                        AutomationException
Deletes the specified child object.

Specified by:
deleteChild in interface IGxObjectContainer
Parameters:
child - A reference to a com.esri.arcgis.catalog.IGxObject (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.