com.esri.arcgis.trackinganalyst
Interface ITxCatalogObject

All Superinterfaces:
Serializable
All Known Implementing Classes:
AddSDEConnection, TxCatalog, TxCatalogObject, TxFolderCatalogObject, TxGISServerFolder

public interface ITxCatalogObject
extends Serializable

Provides access to properties and methods common to all Catalog objects.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.


Method Summary
 void attach(ITxCatalogObject parent, ITxCatalog 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.
 ITxCatalogObject 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 Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

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 Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

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 Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

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 Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Returns:
The category
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getParent

ITxCatalogObject getParent()
                           throws IOException,
                                  AutomationException
The parent of the object.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Returns:
A reference to a com.esri.arcgis.trackinganalyst.ITxCatalogObject
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 Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

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 Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

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 Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Returns:
The isValid
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

attach

void attach(ITxCatalogObject parent,
            ITxCatalog pCatalog)
            throws IOException,
                   AutomationException
Attaches the object to its parent and the catalog.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Parameters:
parent - A reference to a com.esri.arcgis.trackinganalyst.ITxCatalogObject (in)
pCatalog - A reference to a com.esri.arcgis.trackinganalyst.ITxCatalog (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 Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

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 Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.