com.esri.arcgis.trackinganalyst
Class TrackingServiceDef

java.lang.Object
  extended by com.esri.arcgis.trackinganalyst.TrackingServiceDef
All Implemented Interfaces:
com.esri.arcgis.interop.RemoteObjRef, ILibraryItem, ILibraryItem2, ITrackingServiceDef, ITrackingServiceDef2, Serializable

public class TrackingServiceDef
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, ITrackingServiceDef, ITrackingServiceDef2, ILibraryItem, ILibraryItem2

Defines a tracking service in a server connection.

Product Availability

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

See Also:
Serialized Form

Constructor Summary
TrackingServiceDef()
          Constructs a TrackingServiceDef using ArcGIS Engine.
TrackingServiceDef(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
TrackingServiceDef theTrackingServiceDef = (TrackingServiceDef) obj;
 
Method Summary
 boolean equals(Object o)
          Compare this object with another
 String getCategory()
          Indicates category of library item.
static String getClsid()
          getClsid.
 String getID()
          ID value of library item.
 String getMetaData()
          Metadata value for the tracking service.
 String getName()
          Name of the tracking service.
 Object getObjectData()
          Data Source of the tracking object in 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.
 ILibraryObject getParent()
          Indicates parent of library item.
 int getSourceOfGeometry()
          Source of the geometry included in tracking service.
 int hashCode()
          the hashcode for this object
 ILibraryItem libClone()
          Clone this object (library item).
 void setCategory(String pVal)
          Indicates category of library item.
 void setID(String pVal)
          ID value of library item.
 void setIDReadOnly(boolean rhs1)
          Property Make ID Readonly.
 void setMetaData(String pVal)
          Metadata value for the tracking service.
 void setName(String pVal)
          Name of the tracking service.
 void setObjectData(Object pvarFeatureClassName)
          Data Source of the tracking object in 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 setParent(ILibraryObject ppiVal)
          Indicates parent of library item.
 void setSourceOfGeometry(int pVal)
          Source of the geometry included in tracking service.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef
getJintegraDispatch, release
 

Constructor Detail

TrackingServiceDef

public TrackingServiceDef()
                   throws IOException,
                          UnknownHostException
Constructs a TrackingServiceDef using ArcGIS Engine.

Throws:
IOException - if there are interop problems
UnknownHostException - if there are interop problems

TrackingServiceDef

public TrackingServiceDef(Object obj)
                   throws IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
TrackingServiceDef theTrackingServiceDef = (TrackingServiceDef) obj;

Construct a TrackingServiceDef using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to TrackingServiceDef.

Parameters:
obj - an object returned from ArcGIS Engine or Server
Throws:
IOException - if there are interop problems
Method Detail

getClsid

public static String getClsid()
getClsid.


equals

public boolean equals(Object o)
Compare this object with another

Overrides:
equals in class Object

hashCode

public int hashCode()
the hashcode for this object

Overrides:
hashCode in class Object

getName

public 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.

Specified by:
getName in interface ILibraryItem
Specified by:
getName in interface ILibraryItem2
Specified by:
getName in interface ITrackingServiceDef
Specified by:
getName in interface ITrackingServiceDef2
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setName

public 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.

Specified by:
setName in interface ILibraryItem
Specified by:
setName in interface ILibraryItem2
Specified by:
setName in interface ITrackingServiceDef
Specified by:
setName in interface ITrackingServiceDef2
Parameters:
pVal - The pVal (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMetaData

public 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.

Specified by:
getMetaData in interface ITrackingServiceDef
Specified by:
getMetaData in interface ITrackingServiceDef2
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMetaData

public 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.

Specified by:
setMetaData in interface ITrackingServiceDef
Specified by:
setMetaData in interface ITrackingServiceDef2
Parameters:
pVal - The pVal (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getObjectDefinitionName

public String getObjectDefinitionName()
                               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.

Specified by:
getObjectDefinitionName in interface ITrackingServiceDef
Specified by:
getObjectDefinitionName in interface ITrackingServiceDef2
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setObjectDefinitionName

public 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.

Specified by:
setObjectDefinitionName in interface ITrackingServiceDef
Specified by:
setObjectDefinitionName in interface ITrackingServiceDef2
Parameters:
pVal - The pVal (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getObservationDefinitionName

public String getObservationDefinitionName()
                                    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.

Specified by:
getObservationDefinitionName in interface ITrackingServiceDef
Specified by:
getObservationDefinitionName in interface ITrackingServiceDef2
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setObservationDefinitionName

public 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.

Specified by:
setObservationDefinitionName in interface ITrackingServiceDef
Specified by:
setObservationDefinitionName in interface ITrackingServiceDef2
Parameters:
pVal - The pVal (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getObjectSource

public 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.

Specified by:
getObjectSource in interface ITrackingServiceDef
Specified by:
getObjectSource in interface ITrackingServiceDef2
Returns:
A com.esri.arcgis.trackinganalyst.enumObjectSource constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setObjectSource

public 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.

Specified by:
setObjectSource in interface ITrackingServiceDef
Specified by:
setObjectSource in interface ITrackingServiceDef2
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

public 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.

Specified by:
getObjectSourceConnectionString in interface ITrackingServiceDef
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setObjectSourceConnectionString

public 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.

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

getSourceOfGeometry

public 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.

Specified by:
getSourceOfGeometry in interface ITrackingServiceDef
Specified by:
getSourceOfGeometry in interface ITrackingServiceDef2
Returns:
A com.esri.arcgis.trackinganalyst.enumShapeSource constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSourceOfGeometry

public 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.

Specified by:
setSourceOfGeometry in interface ITrackingServiceDef
Specified by:
setSourceOfGeometry in interface ITrackingServiceDef2
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.

getObjectData

public Object getObjectData()
                     throws IOException,
                            AutomationException
Data Source of the tracking object in the tracking service.

Product Availability

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

Specified by:
getObjectData in interface ITrackingServiceDef2
Returns:
A Variant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setObjectData

public void setObjectData(Object pvarFeatureClassName)
                   throws IOException,
                          AutomationException
Data Source of the tracking object in the tracking service.

Product Availability

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

Specified by:
setObjectData in interface ITrackingServiceDef2
Parameters:
pvarFeatureClassName - A Variant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCategory

public String getCategory()
                   throws IOException,
                          AutomationException
Indicates category of library item.

Product Availability

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

Specified by:
getCategory in interface ILibraryItem
Specified by:
getCategory in interface ILibraryItem2
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCategory

public void setCategory(String pVal)
                 throws IOException,
                        AutomationException
Indicates category of library item.

Product Availability

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

Specified by:
setCategory in interface ILibraryItem
Specified by:
setCategory in interface ILibraryItem2
Parameters:
pVal - The pVal (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getID

public String getID()
             throws IOException,
                    AutomationException
ID value of library item.

Product Availability

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

Specified by:
getID in interface ILibraryItem
Specified by:
getID in interface ILibraryItem2
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getParent

public ILibraryObject getParent()
                         throws IOException,
                                AutomationException
Indicates parent of library item.

Product Availability

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

Specified by:
getParent in interface ILibraryItem
Specified by:
getParent in interface ILibraryItem2
Returns:
A reference to a com.esri.arcgis.trackinganalyst.ILibraryObject
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setParent

public void setParent(ILibraryObject ppiVal)
               throws IOException,
                      AutomationException
Indicates parent of library item.

Product Availability

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

Specified by:
setParent in interface ILibraryItem
Specified by:
setParent in interface ILibraryItem2
Parameters:
ppiVal - A reference to a com.esri.arcgis.trackinganalyst.ILibraryObject (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

libClone

public ILibraryItem libClone()
                      throws IOException,
                             AutomationException
Clone this object (library item).

Product Availability

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

Specified by:
libClone in interface ILibraryItem
Specified by:
libClone in interface ILibraryItem2
Returns:
A reference to a com.esri.arcgis.trackinganalyst.ILibraryItem
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setID

public void setID(String pVal)
           throws IOException,
                  AutomationException
ID value of library item.

Product Availability

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

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

setIDReadOnly

public void setIDReadOnly(boolean rhs1)
                   throws IOException,
                          AutomationException
Property Make ID Readonly.

Product Availability

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

Specified by:
setIDReadOnly in interface ILibraryItem2
Parameters:
rhs1 - The rhs1 (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.