com.esri.arcgis.trackinganalyst
Interface IPlugin

All Superinterfaces:

Serializable

All Known Implementing Classes:

PlugIn

public interface IPlugin
extends Serializable

Provides access to methods and properties that data links provide to the Tracking Server so they can be consumed by the Tracking Server.

Product Availability

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

Method Summary

void	disableDataDefinition(String bstrDataDefinitionID) Disables data definition for the data link.
void	disconnect() Disconnects data link.
void	enableDataDefinition(String bstrDataDefinitionID) Enables data definition for the data link.
int	getClientQueueCount() Number of messages in the client queue.waiting to be read by the client object or system of this data link.
Object	getDataFilters() An array of Dataset Definition IDs that are currently Allowed to be read by the plugin when data filtering is enabled.
IDatasetDef	getDataSetDefinition(String bstrName) Gets dataset definition information for the data link.
Object	getDataSetDefinitionList() An array of all dataset defintion names that are defined in the TrackingServer that the data link is connected to.
String	getID() Unique identifier of the current instance of the data link.
String	getName() Name of data link plugin.
int	getServerQueueCount() Number of messages waiting to be published to the server.
int	getStatus() Indicates status of the data link plugin.
Object	getTimeEstablished() Indicates the time the data link plugin was established.
int	getTotalClientMessageCount() Total number of client messages in the data link plugin.
int	getTotalServerMessageCount() Total number of server messages in the data link plugin.
boolean	isEnableDataFiltering() Indicates whether data filtering is enabled for the data link.
IMessage	popClientMessage(int nTimeOut) Retrieves a client message from the data link.
void	postClientMessage(IMessage piMessage) Posts a client message to the data link.
void	returnDataSetDefinition(IDatasetDef piDataSetDef) Returns dataset definition information for the dta link.
IResponseMessage	sendCommand(ICommandMessage piCmdMsg, int nTimeOut) Sends a command to the data link.
void	setEnableDataFiltering(boolean pbvVal) Indicates whether data filtering is enabled for the data link.
void	setName(String pVal) Name of data link plugin.

Method Detail

getDataFilters

Object getDataFilters()
                      throws IOException,
                             AutomationException

An array of Dataset Definition IDs that are currently Allowed to be read by the plugin when data filtering is enabled.

Product Availability

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

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getID

String getID()
             throws IOException,
                    AutomationException

Unique identifier of the current instance of the data link.

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.

getName

String getName()
               throws IOException,
                      AutomationException

Name of data link plugin.

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 data link plugin.

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.

getServerQueueCount

int getServerQueueCount()
                        throws IOException,
                               AutomationException

Number of messages waiting to be published to the server.

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.

getClientQueueCount

int getClientQueueCount()
                        throws IOException,
                               AutomationException

Number of messages in the client queue.waiting to be read by the client object or system of this data link.

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.

getTimeEstablished

Object getTimeEstablished()
                          throws IOException,
                                 AutomationException

Indicates the time the data link plugin was established.

Product Availability

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

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTotalServerMessageCount

int getTotalServerMessageCount()
                               throws IOException,
                                      AutomationException

Total number of server messages in the data link plugin.

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.

getTotalClientMessageCount

int getTotalClientMessageCount()
                               throws IOException,
                                      AutomationException

Total number of client messages in the data link plugin.

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.

getStatus

int getStatus()
              throws IOException,
                     AutomationException

Indicates status of the data link plugin.

Product Availability

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

Returns:

A com.esri.arcgis.trackinganalyst.enumConnectionStatus constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

disconnect

void disconnect()
                throws IOException,
                       AutomationException

Disconnects data link.

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.

postClientMessage

void postClientMessage(IMessage piMessage)
                       throws IOException,
                              AutomationException

Posts a client message to the data link.

Product Availability

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

Parameters:

piMessage - A reference to a com.esri.arcgis.trackinganalyst.IMessage (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

popClientMessage

IMessage popClientMessage(int nTimeOut)
                          throws IOException,
                                 AutomationException

Retrieves a client message from the data link.

Product Availability

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

Parameters:

nTimeOut - The nTimeOut (in)

Returns:

A reference to a com.esri.arcgis.trackinganalyst.IMessage

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDataSetDefinitionList

Object getDataSetDefinitionList()
                                throws IOException,
                                       AutomationException

An array of all dataset defintion names that are defined in the TrackingServer that the data link is connected to.

Product Availability

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

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isEnableDataFiltering

boolean isEnableDataFiltering()
                              throws IOException,
                                     AutomationException

Indicates whether data filtering is enabled for the data link.

Product Availability

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

Returns:

The pbvVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setEnableDataFiltering

void setEnableDataFiltering(boolean pbvVal)
                            throws IOException,
                                   AutomationException

Indicates whether data filtering is enabled for the data link.

Product Availability

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

Parameters:

pbvVal - The pbvVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

enableDataDefinition

void enableDataDefinition(String bstrDataDefinitionID)
                          throws IOException,
                                 AutomationException

Enables data definition for the data link.

Product Availability

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

Parameters:

bstrDataDefinitionID - The bstrDataDefinitionID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

disableDataDefinition

void disableDataDefinition(String bstrDataDefinitionID)
                           throws IOException,
                                  AutomationException

Disables data definition for the data link.

Product Availability

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

Parameters:

bstrDataDefinitionID - The bstrDataDefinitionID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

returnDataSetDefinition

void returnDataSetDefinition(IDatasetDef piDataSetDef)
                             throws IOException,
                                    AutomationException

Returns dataset definition information for the dta link.

Product Availability

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

Parameters:

piDataSetDef - A reference to a com.esri.arcgis.trackinganalyst.IDatasetDef (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDataSetDefinition

IDatasetDef getDataSetDefinition(String bstrName)
                                 throws IOException,
                                        AutomationException

Gets dataset definition information for the data link.

Product Availability

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

Parameters:

bstrName - The bstrName (in)

Returns:

A reference to a com.esri.arcgis.trackinganalyst.IDatasetDef

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

sendCommand

IResponseMessage sendCommand(ICommandMessage piCmdMsg,
                             int nTimeOut)
                             throws IOException,
                                    AutomationException

Sends a command to the data link.

Product Availability

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

Parameters:

piCmdMsg - A reference to a com.esri.arcgis.trackinganalyst.ICommandMessage (in)

nTimeOut - The nTimeOut (in)

Returns:

A reference to a com.esri.arcgis.trackinganalyst.IResponseMessage

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.