com.esri.arcgis.trackinganalyst
Interface ITrackingServiceDef

All Superinterfaces:

Serializable

All Known Implementing Classes:

ITrackingServiceDefProxy, TrackingServiceDef

public interface ITrackingServiceDef
extends Serializable

Provides access to properties that define a tracking service.

Description

Tracking Services are used to define how data is published to ArcGIS products such as ArcMap via the Tracking Analyst Extension and to the Tracking Server web Clients. A Service is one or more data definitions, associated metadata, and the information needed for the client to query for object data. This interface provides access to the properties needed to configure or identify a Tracking Service.

Product Availability

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

Method Summary

String	getMetaData() Metadata value for the tracking service.
String	getName() Name of the tracking service.
String	getObjectDefinitionName() Name that defines the object in the tracking service.
int	getObjectSource() Source of the tracking object in the tracking service.
String	getObjectSourceConnectionString() Connection string of the tracking object's source.
String	getObservationDefinitionName() Name that defines the observation in the tracking service.
int	getSourceOfGeometry() Source of the geometry included in tracking service.
void	setMetaData(String pVal) Metadata value for the tracking service.
void	setName(String pVal) Name of the tracking service.
void	setObjectDefinitionName(String pVal) Name that defines the object in the tracking service.
void	setObjectSource(int pVal) Source of the tracking object in the tracking service.
void	setObjectSourceConnectionString(String pVal) Connection string of the tracking object's source.
void	setObservationDefinitionName(String pVal) Name that defines the observation in the tracking service.
void	setSourceOfGeometry(int pVal) Source of the geometry included in tracking service.

Method Detail

getName

String getName()
               throws IOException,
                      AutomationException

Name of the tracking service.

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.

setName

void setName(String pVal)
             throws IOException,
                    AutomationException

Name of the tracking service.

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.

getMetaData

String getMetaData()
                   throws IOException,
                          AutomationException

Metadata value for the tracking service.

Description

XML Tagged Meta Data describing the Tracking Service. This property is free formed text.

Remarks

It is strongly recommended that a standard xml based geospatial meta data schema is used.

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.

setMetaData

void setMetaData(String pVal)
                 throws IOException,
                        AutomationException

Metadata value for the tracking service.

Description

XML Tagged Meta Data describing the Tracking Service. This property is free formed text.

Remarks

It is strongly recommended that a standard xml based geospatial meta data schema is used.

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.

getObjectDefinitionName

String getObjectDefinitionName()
                               throws IOException,
                                      AutomationException

Name that defines the object in the tracking service.

Description

The name of the data definition that defines the structure of the object data message.

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.

setObjectDefinitionName

void setObjectDefinitionName(String pVal)
                             throws IOException,
                                    AutomationException

Name that defines the object in the tracking service.

Description

The name of the datadefinition that defines the structure of the object data message.

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.

getObservationDefinitionName

String getObservationDefinitionName()
                                    throws IOException,
                                           AutomationException

Name that defines the observation in the tracking service.

Description

The name of the data definition that defines the structure of the observation message.

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.

setObservationDefinitionName

void setObservationDefinitionName(String pVal)
                                  throws IOException,
                                         AutomationException

Name that defines the observation in the tracking service.

Description

The name of the datadefinition that defines the structure of the observation message.

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.

getObjectSource

int getObjectSource()
                    throws IOException,
                           AutomationException

Source of the tracking object in the tracking service.

Description

Indicates where the object data is hosted. Object data can be dynamic or recieved from some live source, or from a Geodatabase source such as a shapefile, Local Geodatabase, or an SDE server.

Product Availability

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

Returns:

A com.esri.arcgis.trackinganalyst.enumObjectSource constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setObjectSource

void setObjectSource(int pVal)
                     throws IOException,
                            AutomationException

Source of the tracking object in the tracking service.

Description

Indicates where the object data is hosted. Object data can be dynamic or recieved from some live source, or from a Geodatabase source such as a shapefile, Local Geodatabase, or an SDE server.

Product Availability

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

Parameters:

pVal - A com.esri.arcgis.trackinganalyst.enumObjectSource constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getObjectSourceConnectionString

String getObjectSourceConnectionString()
                                       throws IOException,
                                              AutomationException

Connection string of the tracking object's source.

Description

This property is now Obsolete. Use ITrackingServiceDef2's ObjectData to retrieve the datasetName object.

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.

setObjectSourceConnectionString

void setObjectSourceConnectionString(String pVal)
                                     throws IOException,
                                            AutomationException

Connection string of the tracking object's source.

Description

This property is now Obsolete. Use ITrackingServiceDef2's ObjectData to retrieve the datasetName object.

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.

getSourceOfGeometry

int getSourceOfGeometry()
                        throws IOException,
                               AutomationException

Source of the geometry included in tracking service.

Description

This property inidcates which data set definition contains the geometry. At least one and only one must have a Geometry in order for a tracking service to be valid.

Product Availability

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

Returns:

A com.esri.arcgis.trackinganalyst.enumShapeSource constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSourceOfGeometry

void setSourceOfGeometry(int pVal)
                         throws IOException,
                                AutomationException

Source of the geometry included in tracking service.

Description

This property inidcates which data set definition contains the geometry. At least one and only one must have a Geometry in order for a tracking service to be valid.

Product Availability

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

Parameters:

pVal - A com.esri.arcgis.trackinganalyst.enumShapeSource constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.