com.esri.arcgis.catalog
Class GxGISServersFolder

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

All Implemented Interfaces:

IGxGISServersFolder, IGxObject, IGxObjectContainer, IGxObjectUI, IGxRemoteContainer, IGxRootObjectSortPriority, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class GxGISServersFolder
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IGxObject, IGxObjectUI, IGxObjectContainer, IGxGISServersFolder, IGxRemoteContainer, IGxRootObjectSortPriority

Container of GIS servers.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

See Also:

Serialized Form

Constructor Summary

GxGISServersFolder()
Constructs a GxGISServersFolder using ArcGIS Engine.

GxGISServersFolder(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
GxGISServersFolder theGxGISServersFolder = (GxGISServersFolder) 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.
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.
IUID	getNewMenu() The class ID of the New menu for this object.
IGxObject	getParent() The parent of the object.
String	getPath() The full path for the GIS servers folder.
int	getSmallImage() The small image that represents the object.
int	getSmallSelectedImage() The small image that represents the object when it is selected.
int	getSortPriority() Returns the sort priority for the Root level Object.
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	isValid() Indicates if the object is still valid.
void	refresh() Updates the object and any children of the object.
void	setPath(String path) The full path for the GIS servers folder.

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

GxGISServersFolder

public GxGISServersFolder()
                   throws IOException,
                          UnknownHostException

Constructs a GxGISServersFolder using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

GxGISServersFolder

public GxGISServersFolder(Object obj)
                   throws IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
GxGISServersFolder theGxGISServersFolder = (GxGISServersFolder) obj;

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

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

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.

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.

setPath

public void setPath(String path)
             throws IOException,
                    AutomationException

The full path for the GIS servers folder.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setPath in interface IGxGISServersFolder

Parameters:

path - The path (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPath

public String getPath()
               throws IOException,
                      AutomationException

The full path for the GIS servers folder.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getPath in interface IGxGISServersFolder

Returns:

The path

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSortPriority

public int getSortPriority()
                    throws IOException,
                           AutomationException

Returns the sort priority for the Root level Object.

Product Availability

Available with ArcGIS Desktop.

Specified by:

getSortPriority in interface IGxRootObjectSortPriority

Returns:

The priority

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.