com.esri.arcgis.catalog
Interface IGxObject

All Superinterfaces:

Serializable

All Known Implementing Classes:

GxAddAGSConnection, GxAddAGSObject, GxAddGDSConnection, GxAddWCSConnection, GxAddWMSConnection, GxAddWMTSConnection, GxAGSCatalog, GxAGSConnection, GxAGSDraft, GxAGSDraftFolder, GxAGSFeatureServer, GxAGSFolder, GxAGSGeoDataServer, GxAGSGeometry, GxAGSGeoprocessing, GxAGSGlobe, GxAGSGlobeLayer, GxAGSImage, GxAGSLocator, GxAGSMap, GxAGSWMServer, GxCadDataset, GxCatalog, GxCoverageDataset, GxDatabase, GxDatabaseServerFolder, GxDataGraph, GxDataServer, GxDataset, GxDiskConnection, GxExcelFile, GxFeatureDefinitionPackage, GxFile, GxFolder, GxFolderConnections, GxGDSGeodatabase, GxGeoprocessingResult, GxGISServersFolder, GxLayer, GxMap, GxMetadata, GxMSDFile, GxMyHostedMapsFolder, GxNewDatabase, GxPackage, GxPCCoverage, GxPre70Coverage, GxPrjFile, GxRasterDataset, GxRemoteDatabaseFolder, GxReport, GxSDCDataset, GxServiceDefinition, GxShapefileDataset, GxShortcut, GxSpatialReferencesFolder, GxSpatialWeightsMatrixFile, GxStreetMapDataset, GxTextFile, GxTool, GxToolbox, GxToolboxesFolder, GxToolboxesRoot, GxToolset, GxVpfDataset, GxWCSConnection, GxWCSCoverage, GxWMSConnection, GxWMSLayer, GxWMSMap, GxWMTSConnection, GxWMTSLayer, GxWorkspaceFolder, IGxObjectProxy, IMSConnection, IMSFeatureClass, IMSFeatureService, IMSGlobeServiceDescription, IMSGlobeSubServiceDescription, IMSImageMap, IMSMetadataService, NewIMSConnection, SearchResults, SearchResultsRoot

public interface IGxObject
extends Serializable

Provides access to members that are common to all GxObjects.

Product Availability

Available with ArcGIS Desktop.

Method Summary

void	attach(IGxObject parent, IGxCatalog pCatalog) Attaches the object to its parent and the catalog.
void	detach() Instructs the object to detach itself from its parent and the catalog.
String	getBaseName() The base name of the object (i.e.
String	getCategory() The category of the object.
IUID	getClassID() The class ID of this object.
String	getFullName() The full name of the object.
IName	getInternalObjectName() The Name for the internal object that this GxObject represents.
String	getName() The short name of the object.
IGxObject	getParent() The parent of the object.
boolean	isValid() Indicates if the object is still valid.
void	refresh() Updates the object and any children of the object.

Method Detail

getName

String getName()
               throws IOException,
                      AutomationException

The short name of the object.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFullName

String getFullName()
                   throws IOException,
                          AutomationException

The full name of the object.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBaseName

String getBaseName()
                   throws IOException,
                          AutomationException

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

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCategory

String getCategory()
                   throws IOException,
                          AutomationException

The category of the object.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

The category

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getParent

IGxObject getParent()
                    throws IOException,
                           AutomationException

The parent of the object.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

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

IUID getClassID()
                throws IOException,
                       AutomationException

The class ID of this object.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

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

IName getInternalObjectName()
                            throws IOException,
                                   AutomationException

The Name for the internal object that this GxObject represents.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

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

boolean isValid()
                throws IOException,
                       AutomationException

Indicates if the object is still valid.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

The isValid

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

attach

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

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

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

refresh

void refresh()
             throws IOException,
                    AutomationException

Updates the object and any children of the object.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.