com.esri.arcgis.trackinganalyst
Interface IAMSDatasetName

All Superinterfaces:
IDatasetName, Serializable
All Known Implementing Classes:
AMSDatasetName

public interface IAMSDatasetName
extends IDatasetName, Serializable

Provides access to properties and methods needed to manage dataset names in the tracking workspace.

Description

This interface exposes properties and methods that are used to manage dataset definitions to be listed or used within the conventional workspace metaphor. This object provides a dataset definition ID property as well as name, description, and enabled properties. The enabled property determines whether this is listed as a dataset from the IWorkspace interface.

Product Availability

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


Method Summary
 IDatasetName getFeatureDatasetName()
          The Feature Dataset Name object.
 int getFeatureType()
          The feature type for this feature class name.
 String getShapeFieldName()
          The spatial column name for this feature class name.
 int getShapeType()
          The feature class shape type.
 String getTemporalColumnName()
          Name of the column containing the time and date information.
 ITrackingServiceDef getTrackingService()
          Defines a tracking service within the real-time data connection in the workspace.
 boolean isVisible()
          Indicates whether or not the dataset name is visible in the workspace dialog.
 void setFeatureDatasetNameByRef(IDatasetName featureDatasetName)
          The Feature Dataset Name object.
 void setFeatureType(int type)
          The feature type for this feature class name.
 void setShapeFieldName(String name)
          The spatial column name for this feature class name.
 void setShapeType(int type)
          The feature class shape type.
 void setTrackingServiceByRef(ITrackingServiceDef pVal)
          Defines a tracking service within the real-time data connection in the workspace.
 void setVisible(boolean pVal)
          Indicates whether or not the dataset name is visible in the workspace dialog.
 
Methods inherited from interface com.esri.arcgis.geodatabase.IDatasetName
getCategory, getName, getSubsetNames, getType, getWorkspaceName, setCategory, setName, setWorkspaceNameByRef
 

Method Detail

isVisible

boolean isVisible()
                  throws IOException,
                         AutomationException
Indicates whether or not the dataset name is visible in the workspace dialog.

Description

This property indicates whether or not to list this dataset name in the dataset's property of IWorkspace.

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.

setVisible

void setVisible(boolean pVal)
                throws IOException,
                       AutomationException
Indicates whether or not the dataset name is visible in the workspace dialog.

Description

This property indicates whether or not to list this dataset name in the dataset's property of IWorkspace.

Product Availability

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

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

getTemporalColumnName

String getTemporalColumnName()
                             throws IOException,
                                    AutomationException
Name of the column containing the time and date information.

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.

getTrackingService

ITrackingServiceDef getTrackingService()
                                       throws IOException,
                                              AutomationException
Defines a tracking service within the real-time data connection in the workspace.

Product Availability

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

Returns:
A reference to a com.esri.arcgis.trackinganalyst.ITrackingServiceDef
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTrackingServiceByRef

void setTrackingServiceByRef(ITrackingServiceDef pVal)
                             throws IOException,
                                    AutomationException
Defines a tracking service within the real-time data connection in the workspace.

Product Availability

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

Parameters:
pVal - A reference to a com.esri.arcgis.trackinganalyst.ITrackingServiceDef (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getShapeType

int getShapeType()
                 throws IOException,
                        AutomationException
The feature class shape type.

Product Availability

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

Returns:
A com.esri.arcgis.geometry.esriGeometryType constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setShapeType

void setShapeType(int type)
                  throws IOException,
                         AutomationException
The feature class shape type.

Product Availability

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

Parameters:
type - A com.esri.arcgis.geometry.esriGeometryType constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFeatureDatasetName

IDatasetName getFeatureDatasetName()
                                   throws IOException,
                                          AutomationException
The Feature Dataset Name object.

Product Availability

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

Returns:
A reference to a com.esri.arcgis.geodatabase.IDatasetName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setFeatureDatasetNameByRef

void setFeatureDatasetNameByRef(IDatasetName featureDatasetName)
                                throws IOException,
                                       AutomationException
The Feature Dataset Name object.

Product Availability

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

Parameters:
featureDatasetName - A reference to a com.esri.arcgis.geodatabase.IDatasetName (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFeatureType

int getFeatureType()
                   throws IOException,
                          AutomationException
The feature type for this feature class name.

Product Availability

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

Returns:
A com.esri.arcgis.geodatabase.esriFeatureType constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setFeatureType

void setFeatureType(int type)
                    throws IOException,
                           AutomationException
The feature type for this feature class name.

Product Availability

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

Parameters:
type - A com.esri.arcgis.geodatabase.esriFeatureType constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getShapeFieldName

String getShapeFieldName()
                         throws IOException,
                                AutomationException
The spatial column name for this feature class name.

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.

setShapeFieldName

void setShapeFieldName(String name)
                       throws IOException,
                              AutomationException
The spatial column name for this feature class name.

Product Availability

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

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