com.esri.arcgis.trackinganalyst
Interface ITxCatalog

All Superinterfaces:
Serializable
All Known Implementing Classes:
TxCatalog

public interface ITxCatalog
extends Serializable

Provides access to properties and methods needed to use the CJMTK catalog object natively, aka GUI less.

Product Availability

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


Method Summary
 void close()
          Close the Open Catalog and save its state to the current path.
 ITxCatalogObject connectFolder(String bstrFolderPath)
          Connect a folder to the root level of the Catalog.
 void disconnectFolder(String bstrFolderPath)
          Disconnect a folder from the root level of the Catalog.
 void esri_new()
          Creates a Default Catalog Removing any customized folders or root objects added.
 String getPath()
          The current path of the Catalogs configuration file.
 void open(String bstrCatalogPath)
          Opens a Catalog Configuration File at the specified path.
 void save(String bstrPath)
          Save the catalogs state to a configurations file at the Path specified.
 

Method Detail

connectFolder

ITxCatalogObject connectFolder(String bstrFolderPath)
                               throws IOException,
                                      AutomationException
Connect a folder to the root level of the Catalog.

Product Availability

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

Parameters:
bstrFolderPath - The bstrFolderPath (in)
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.

disconnectFolder

void disconnectFolder(String bstrFolderPath)
                      throws IOException,
                             AutomationException
Disconnect a folder from the root level of the Catalog.

Product Availability

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

Parameters:
bstrFolderPath - The bstrFolderPath (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

close

void close()
           throws IOException,
                  AutomationException
Close the Open Catalog and save its state to the current path.

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.

getPath

String getPath()
               throws IOException,
                      AutomationException
The current path of the Catalogs configuration file.

Product Availability

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

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

esri_new

void esri_new()
              throws IOException,
                     AutomationException
Creates a Default Catalog Removing any customized folders or root objects added.

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.

open

void open(String bstrCatalogPath)
          throws IOException,
                 AutomationException
Opens a Catalog Configuration File at the specified path.

Product Availability

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

Parameters:
bstrCatalogPath - The bstrCatalogPath (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

save

void save(String bstrPath)
          throws IOException,
                 AutomationException
Save the catalogs state to a configurations file at the Path specified.

Product Availability

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

Parameters:
bstrPath - The bstrPath (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.