com.esri.arcgis.trackinganalyst
Class ITrackingServiceDefProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.trackinganalyst.ITrackingServiceDefProxy

All Implemented Interfaces:

ITrackingServiceDef, Externalizable, Serializable

public class ITrackingServiceDefProxy
extends com.esri.arcgis.interop.Dispatch
implements ITrackingServiceDef, 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.

See Also:

Serialized Form

Field Summary

boolean

noncastable

Fields inherited from class com.esri.arcgis.interop.Dispatch

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef

Constructor Summary

	ITrackingServiceDefProxy()
	ITrackingServiceDefProxy(Object obj)
protected	ITrackingServiceDefProxy(Object obj, String iid)

Method Summary

void	addListener(String iidStr, Object theListener, Object theSource)
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	removeListener(String iidStr, Object theListener)
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.

Methods inherited from class com.esri.arcgis.interop.Dispatch

bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, optimizedVtblInvoke, queryInterface, readExternal, release, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

noncastable

public boolean noncastable

Constructor Detail

ITrackingServiceDefProxy

public ITrackingServiceDefProxy()

ITrackingServiceDefProxy

public ITrackingServiceDefProxy(Object obj)
                         throws IOException

Throws:

IOException

ITrackingServiceDefProxy

protected ITrackingServiceDefProxy(Object obj,
                                   String iid)
                            throws IOException

Throws:

IOException

Method Detail

addListener

public void addListener(String iidStr,
                        Object theListener,
                        Object theSource)
                 throws IOException

Overrides:

addListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

removeListener

public void removeListener(String iidStr,
                           Object theListener)
                    throws IOException

Overrides:

removeListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

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 ITrackingServiceDef

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 ITrackingServiceDef

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

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

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

Specified by:

getObjectDefinitionName in interface ITrackingServiceDef

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

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

Specified by:

getObservationDefinitionName in interface ITrackingServiceDef

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

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

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

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

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

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.