com.esri.arcgis.catalog
Class IMSGlobeServiceDescription

java.lang.Object
  com.esri.arcgis.catalog.IMSGlobeServiceDescription

All Implemented Interfaces:

IGxObject, IGxObjectContainer, IGxObjectUI, IIMSServiceDescription, IIMSUserRole, com.esri.arcgis.interop.RemoteObjRef, IName, Serializable

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

GxObject that represents ArcIMS Globe File.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

See Also:

Serialized Form

Constructor Summary

IMSGlobeServiceDescription()
Constructs a IMSGlobeServiceDescription using ArcGIS Engine.

IMSGlobeServiceDescription(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(Object o) Compare this object with another
String	getBaseName() The base name of the object (i.e.
String	getCategory() The category of the object.
IEnumGxObject	getChildren() An enumeration of the child objects.
IUID	getClassID() The class ID of this object.
static String	getClsid() getClsid.
IPropertySet	getConnectionProperties() True if the service is free.
IUID	getContextMenu() The class ID of the context menu for this object.
String	getFullName() The full name of the object.
IName	getInternalObjectName() The Name for the internal object that this GxObject represents.
int	getLargeImage() The large image that represents the object.
int	getLargeSelectedImage() The large image that represents the object when it is selected.
String	getName() The short name of the object.
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.
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.
String	getURL() URL to ArcIMS server.
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.
Object	open() Opens the object referred to by this name.
void	refresh() Updates the object and any children of the object.
void	setConnectionProperties(IPropertySet connectionProperties) True if the service is free.
void	setIsPrivate(boolean isPrivate) Indicates if the service is private (requires password).
void	setName(String name) Service Name.
void	setNameString(String nameString) The name string of the object.
void	setPassword(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(String uRL) URL to ArcIMS server.
void	setUserName(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

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

IMSGlobeServiceDescription

public IMSGlobeServiceDescription()
                           throws IOException,
                                  UnknownHostException

Constructs a IMSGlobeServiceDescription using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

IMSGlobeServiceDescription

public IMSGlobeServiceDescription(Object obj)
                           throws 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:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

getName

public String getName()
               throws IOException,
                      AutomationException

The short name of the object.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getName in interface IGxObject

Specified by:

getName in interface IIMSServiceDescription

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFullName

public String getFullName()
                   throws IOException,
                          AutomationException

The full name of the object.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getFullName in interface IGxObject

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBaseName

public String getBaseName()
                   throws IOException,
                          AutomationException

The base name of the object (i.e. no extension).

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getBaseName in interface IGxObject

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCategory

public String getCategory()
                   throws IOException,
                          AutomationException

The category of the object.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getCategory in interface IGxObject

Returns:

The category

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getParent

public IGxObject getParent()
                    throws IOException,
                           AutomationException

The parent of the object.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getParent in interface IGxObject

Returns:

A reference to a com.esri.arcgis.catalog.IGxObject

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassID

public IUID getClassID()
                throws IOException,
                       AutomationException

The class ID of this object.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getClassID in interface IGxObject

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getInternalObjectName

public IName getInternalObjectName()
                            throws IOException,
                                   AutomationException

The Name for the internal object that this GxObject represents.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getInternalObjectName in interface IGxObject

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isValid

public boolean isValid()
                throws IOException,
                       AutomationException

Indicates if the object is still valid.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

isValid in interface IGxObject

Returns:

The isValid

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

attach

public void attach(IGxObject parent,
                   IGxCatalog pCatalog)
            throws IOException,
                   AutomationException

Attaches the object to its parent and the catalog.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

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:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

detach

public void detach()
            throws IOException,
                   AutomationException

Instructs the object to detach itself from its parent and the catalog.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

detach in interface IGxObject

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

refresh

public void refresh()
             throws IOException,
                    AutomationException

Updates the object and any children of the object.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

refresh in interface IGxObject

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSmallImage

public int getSmallImage()
                  throws IOException,
                         AutomationException

The small image that represents the object.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getSmallImage in interface IGxObjectUI

Returns:

The hBitmap (A COM typedef)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSmallSelectedImage

public int getSmallSelectedImage()
                          throws IOException,
                                 AutomationException

The small image that represents the object when it is selected.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getSmallSelectedImage in interface IGxObjectUI

Returns:

The hBitmap (A COM typedef)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLargeImage

public int getLargeImage()
                  throws IOException,
                         AutomationException

The large image that represents the object.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getLargeImage in interface IGxObjectUI

Returns:

The hBitmap (A COM typedef)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLargeSelectedImage

public int getLargeSelectedImage()
                          throws IOException,
                                 AutomationException

The large image that represents the object when it is selected.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getLargeSelectedImage in interface IGxObjectUI

Returns:

The hBitmap (A COM typedef)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getContextMenu

public IUID getContextMenu()
                    throws IOException,
                           AutomationException

The class ID of the context menu for this object.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getContextMenu in interface IGxObjectUI

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNewMenu

public IUID getNewMenu()
                throws IOException,
                       AutomationException

The class ID of the New menu for this object.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getNewMenu in interface IGxObjectUI

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setName

public void setName(String name)
             throws IOException,
                    AutomationException

Service Name.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setName in interface IIMSServiceDescription

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getURL

public String getURL()
              throws IOException,
                     AutomationException

URL to ArcIMS server.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getURL in interface IIMSServiceDescription

Returns:

The uRL

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setURL

public void setURL(String uRL)
            throws IOException,
                   AutomationException

URL to ArcIMS server.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setURL in interface IIMSServiceDescription

Parameters:

uRL - The uRL (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUserName

public void setUserName(String userName)
                 throws IOException,
                        AutomationException

User name for the specified service.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setUserName in interface IIMSServiceDescription

Parameters:

userName - The userName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getUserName

public String getUserName()
                   throws IOException,
                          AutomationException

User name for the specified service.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getUserName in interface IIMSServiceDescription

Returns:

The userName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPassword

public Object getPassword()
                   throws IOException,
                          AutomationException

Password for the specified service.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getPassword in interface IIMSServiceDescription

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPassword

public void setPassword(String password)
                 throws IOException,
                        AutomationException

Password for the specified service.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setPassword in interface IIMSServiceDescription

Parameters:

password - The password (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSavePassword

public boolean isSavePassword()
                       throws IOException,
                              AutomationException

Indicates if the password should be saved.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isSavePassword in interface IIMSServiceDescription

Returns:

The flag

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSavePassword

public void setSavePassword(boolean flag)
                     throws IOException,
                            AutomationException

Indicates if the password should be saved.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setSavePassword in interface IIMSServiceDescription

Parameters:

flag - The flag (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getServiceType

public int getServiceType()
                   throws IOException,
                          AutomationException

Type of service.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getServiceType in interface IIMSServiceDescription

Returns:

A com.esri.arcgis.gisclient.acServiceType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setServiceType

public void setServiceType(int type)
                    throws IOException,
                           AutomationException

Type of service.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setServiceType in interface IIMSServiceDescription

Parameters:

type - A com.esri.arcgis.gisclient.acServiceType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSecurity

public int getSecurity()
                throws IOException,
                       AutomationException

Type of security set on the service. Use a combination of acSecurityType constants.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSecurity in interface IIMSServiceDescription

Returns:

The security

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSecurity

public void setSecurity(int security)
                 throws IOException,
                        AutomationException

Type of security set on the service. Use a combination of acSecurityType constants.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setSecurity in interface IIMSServiceDescription

Parameters:

security - The security (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isPrivate

public boolean isPrivate()
                  throws IOException,
                         AutomationException

Indicates if the service is private (requires password).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isPrivate in interface IIMSServiceDescription

Returns:

The isPrivate

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIsPrivate

public void setIsPrivate(boolean isPrivate)
                  throws IOException,
                         AutomationException

Indicates if the service is private (requires password).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setIsPrivate in interface IIMSServiceDescription

Parameters:

isPrivate - The isPrivate (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getConnectionProperties

public IPropertySet getConnectionProperties()
                                     throws IOException,
                                            AutomationException

True if the service is free.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getConnectionProperties in interface IIMSServiceDescription

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setConnectionProperties

public void setConnectionProperties(IPropertySet connectionProperties)
                             throws IOException,
                                    AutomationException

True if the service is free.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setConnectionProperties in interface IIMSServiceDescription

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getUserRole

public int getUserRole()
                throws IOException,
                       AutomationException

User role.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getUserRole in interface IIMSUserRole

Returns:

A com.esri.arcgis.gisclient.acUserRole constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUserRole

public void setUserRole(int role)
                 throws IOException,
                        AutomationException

User role.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setUserRole in interface IIMSUserRole

Parameters:

role - A com.esri.arcgis.gisclient.acUserRole constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isHasChildren

public boolean isHasChildren()
                      throws IOException,
                             AutomationException

Indicates if the object has any children.

Remarks

Note: This property always return True even when it has no children. This was done to improve the overall ArcCatalog browsing performance.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

isHasChildren in interface IGxObjectContainer

Returns:

The hasChildren

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getChildren

public IEnumGxObject getChildren()
                          throws IOException,
                                 AutomationException

An enumeration of the child objects.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getChildren in interface IGxObjectContainer

Returns:

A reference to a com.esri.arcgis.catalog.IEnumGxObject

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isAreChildrenViewable

public boolean isAreChildrenViewable()
                              throws IOException,
                                     AutomationException

Indicates if the objects children are available for viewing in the tree-view.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

isAreChildrenViewable in interface IGxObjectContainer

Returns:

The areViewable

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addChild

public IGxObject addChild(IGxObject child)
                   throws 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.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

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:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deleteChild

public void deleteChild(IGxObject child)
                 throws IOException,
                        AutomationException

Deletes the specified child object.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

deleteChild in interface IGxObjectContainer

Parameters:

child - A reference to a com.esri.arcgis.catalog.IGxObject (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setNameString

public void setNameString(String nameString)
                   throws 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:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNameString

public String getNameString()
                     throws 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:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

open

public Object open()
            throws 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:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.