com.esri.arcgis.trackinganalyst
Interface IServerConnection

All Superinterfaces:
Serializable
All Known Implementing Classes:
GeneralTrackingConnector, InternetConnection, ServerConnection

public interface IServerConnection
extends Serializable

Provides access to the methods and properties for a connector object to connect to a Tracking Server.

Superseded By

IServerConnection2

Product Availability

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


Method Summary
 void connect(String bstrUserName, String bstrPassword)
          Creates connection to the server.
 void disableDataDefinition(String bstrDataDefinitionID)
          Disables data definition for the server connection.
 void disconnect()
          Disconnects connection from the server.
 void enableDataDefinition(String bstrDataDefinitionID)
          Enables data definition for the server connection.
 String getConnectionName()
          Indicates the name of the connection to the server.
 String getConnectionString()
          Connection string value for the server connection.
 IDatasetDef getDataSetDefinition(String bstrName)
          Gets dataset definition information for the server connection.
 Object getDataSetDefinitionList()
          Lists the dataset definition information for the connection.
 Object getEnabledDataDefinitions()
          Indicates which data definitions are enabled.
 int getLastConnectionErrorCode()
          Indicates the error code for the last connection to the server.
 String getLastConnectionErrorMessage()
          Indicates the error message for the last connection to the server.
 IMessage getMessage(int nTimeOutInMilliseconds)
          Retrieves a message from the server connection.
 String getServerName()
          Name for the server.
 String getUserName()
          User's login name.
 boolean isConnected()
          Indicates whether the server connection is connected.
 boolean isEnableDataFiltering()
          Indicates whether data filtering is enabled for the connection.
 void returnDataSetDefinition(IDatasetDef piDataSetDef)
          Returns dataset definition information for the server connection.
 IResponseMessage sendCommand(ICommandMessage piCmdMsg, int nTimeOut)
          Sends a command to the server connection.
 void sendMessage(IMessage piMessage)
          Sends a message through the server connection path.
 void setConnectionName(String pbstrConnectionName)
          Indicates the name of the connection to the server.
 void setConnectionString(String pbstrConnectionString)
          Connection string value for the server connection.
 void setEnableDataFiltering(boolean pbvVal)
          Indicates whether data filtering is enabled for the connection.
 void setServerName(String pVal)
          Name for the server.
 

Method Detail

isConnected

boolean isConnected()
                    throws IOException,
                           AutomationException
Indicates whether the server connection is connected.

Description

This property indicates the connection state to the TMS 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.

getServerName

String getServerName()
                     throws IOException,
                            AutomationException
Name for the server.

Description

This property indicates the current server that we are connected to. If a connection does not exist this property contains an empty string.

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.

setServerName

void setServerName(String pVal)
                   throws IOException,
                          AutomationException
Name for the server.

Description

This property sets the TMS server to connected to. The default of an empty string is localhost

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.

getUserName

String getUserName()
                   throws IOException,
                          AutomationException
User's login name.

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.

isEnableDataFiltering

boolean isEnableDataFiltering()
                              throws IOException,
                                     AutomationException
Indicates whether data filtering is enabled for the connection.

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

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.

getDataSetDefinitionList

Object getDataSetDefinitionList()
                                throws IOException,
                                       AutomationException
Lists the dataset definition information for the connection.

Description

This read only property returns an array of all available datasetdefinitions names. A user can then use the getDataSetDefinition and returnDataSetDefinition methods to retrieve and return the actual object.

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.

getEnabledDataDefinitions

Object getEnabledDataDefinitions()
                                 throws IOException,
                                        AutomationException
Indicates which data definitions are 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.

getLastConnectionErrorCode

int getLastConnectionErrorCode()
                               throws IOException,
                                      AutomationException
Indicates the error code for the last connection to the server.

Product Availability

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

Returns:
The pnErrorCode
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLastConnectionErrorMessage

String getLastConnectionErrorMessage()
                                     throws IOException,
                                            AutomationException
Indicates the error message for the last connection to the server.

Product Availability

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

Returns:
The pbstrErrorMessage
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getConnectionName

String getConnectionName()
                         throws IOException,
                                AutomationException
Indicates the name of the connection to the server.

Product Availability

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

Returns:
The pbstrConnectionName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setConnectionName

void setConnectionName(String pbstrConnectionName)
                       throws IOException,
                              AutomationException
Indicates the name of the connection to the server.

Product Availability

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

Parameters:
pbstrConnectionName - The pbstrConnectionName (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getConnectionString

String getConnectionString()
                           throws IOException,
                                  AutomationException
Connection string value for the server connection.

Product Availability

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

Returns:
The pbstrConnectionString
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setConnectionString

void setConnectionString(String pbstrConnectionString)
                         throws IOException,
                                AutomationException
Connection string value for the server connection.

Product Availability

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

Parameters:
pbstrConnectionString - The pbstrConnectionString (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

connect

void connect(String bstrUserName,
             String bstrPassword)
             throws IOException,
                    AutomationException
Creates connection to the server.

Product Availability

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

Parameters:
bstrUserName - The bstrUserName (in)
bstrPassword - The bstrPassword (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

disconnect

void disconnect()
                throws IOException,
                       AutomationException
Disconnects connection from the server.

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.

sendMessage

void sendMessage(IMessage piMessage)
                 throws IOException,
                        AutomationException
Sends a message through the server connection path.

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.

getMessage

IMessage getMessage(int nTimeOutInMilliseconds)
                    throws IOException,
                           AutomationException
Retrieves a message from the server connection.

Product Availability

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

Parameters:
nTimeOutInMilliseconds - The nTimeOutInMilliseconds (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.

enableDataDefinition

void enableDataDefinition(String bstrDataDefinitionID)
                          throws IOException,
                                 AutomationException
Enables data definition for the server connection.

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

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

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

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

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.