com.esri.arcgis.trackinganalyst
Interface IConnection

All Superinterfaces:

Serializable

All Known Implementing Classes:

PlugIn

public interface IConnection
extends Serializable

Provides access to methods and properties implemented by datalinks and consumed by the Tracking Server.

Product Availability

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

Method Summary

void	disconnect() Disconnects current connection to Tracking Server and/or data link.
int	getClientQueueCount() Number of connections listed in the client queue.
Object	getDataFilters() Value for data filters used in the connection to the data link and/or Tracking Server.
String	getID() ID value for data in the connection.
String	getName() Name of dataset in the connection.
int	getServerQueueCount() Number of connections included in the Tracking Server queue.
int	getStatus() Status of the connection.
Object	getTimeEstablished() Indicates time that connection was established.
int	getTotalClientMessageCount() Total number of client messages included in the connection.
int	getTotalServerMessageCount() Total number of server messages included in connection.
void	setName(String pVal) Name of dataset in the connection.

Method Detail

getDataFilters

Object getDataFilters()
                      throws IOException,
                             AutomationException

Value for data filters used in the connection to the data link and/or Tracking Server.

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

ID value for data in the connection.

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 dataset in the connection.

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 dataset in the connection.

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 connections included in the Tracking Server queue.

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 connections listed in the client queue.

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 time that connection 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 included in connection.

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 included in the connection.

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

Status of the connection.

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 current connection to Tracking Server and/or 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.