Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.esri.arcgis.trackinganalyst
Interface IInternetServerConnection

All Superinterfaces:
Serializable
All Known Implementing Classes:
InternetConnection
public interface IInternetServerConnection
extends Serializable

Provides access to properties and methods needed to help manage Internet server connections.

Description

This interface provides access to properties and methods needed to help manage Internet server connections. Use this interface to make a server connection, manage data definitions and get error message/code, etc.

Product Availability

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

Method Summary
 void connect(String bstrUserName, String bstrPassword)
          Creates Internet server connection.
 void disableDataDefinition(String bstrDataDefinitionID)
          Disables dataset definition for the Internet server connection.
 void disconnect()
          Disconnects Internet server connection.
 void enableDataDefinition(String bstrDataDefinitionID)
          Enables data definition for the Internet server connection.
 String getConnectionName()
          Name of Internet server connection.
 String getConnectionString()
          Indicates connection string value.
 IDatasetDef getDataSetDefinition(String bstrName)
          Gets value for dataset definition for Internet server connection.
 Object getDataSetDefinitionList()
          Lists values in the dataset definition.
 Object getEnabledDataDefinitions()
          Indicates whether data definitions are enabled for the Internet server connection.
 int getLastConnectionErrorCode()
          Indicates error code value for the last Internet server connection.
 String getLastConnectionErrorMessage()
          Indicates error code value for the last Internet server connection.
 IMessage getMessage(int nTimeOutInMilliseconds)
          Gets message via the Internet server connection.
 int getPortNumber()
          Port number used for the Internet server connection.
 String getServerName()
          Indicates server name in the Internet server connection.
 String getSubletPath()
          Value of the sublet path for the Internet server connection.
 String getTopicName(String bstrServiceName)
          Indicates name for the topic in the Internet server connection.
 ITrackingServiceDef getTrackingService(String bstrName)
          Gets tracking service information for the Internet server connection.
 Object getTrackingServicesList()
          Lists tracking services within the Internet server connection.
 String getUserName()
          Indicates user's name using the Internet server connection.
 boolean isConnected()
          Indicates whether the Internet server connection is active.
 boolean isEnableDataFiltering()
          Indicates whether data filtering is enabled for the Internet server connection.
 void returnDataSetDefinition(IDatasetDef piDataSetDef)
          Returns value for dataset definition in Internet server connection.
 void returnTrackingService(ITrackingServiceDef piTrackingServiceDef)
          Returns tracking service information for the Internet server connection.
 IResponseMessage sendCommand(ICommandMessage piCmdMsg, int nTimeOut)
          Sends command information via the Internet server connection.
 void sendMessage(IMessage piMessage)
          Sends message via the Internet server connection.
 void setConnectionName(String pbstrConnectionName)
          Name of Internet server connection.
 void setConnectionString(String pbstrConnectionString)
          Indicates connection string value.
 void setEnableDataFiltering(boolean pbvVal)
          Indicates whether data filtering is enabled for the Internet server connection.
 void setPortNumber(int plPortNumber)
          Port number used for the Internet server connection.
 void setServerName(String pVal)
          Indicates server name in the Internet server connection.
 void setSubletPath(String pbstrSubletPath)
          Value of the sublet path for the Internet server connection.
 void setTopicName(String bstrServiceName, String pbstrTopicName)
          Indicates name for the topic in the Internet server connection.
 

Method Detail

isConnected

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

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
Indicates server name in the Internet server 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.

setServerName

void setServerName(String pVal)
                   throws IOException,
                          AutomationException
Indicates server name in the Internet server 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.

getUserName

String getUserName()
                   throws IOException,
                          AutomationException
Indicates user's name using the Internet server 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.

isEnableDataFiltering

boolean isEnableDataFiltering()
                              throws IOException,
                                     AutomationException
Indicates whether data filtering is enabled for the Internet server 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 Internet server 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 values in the dataset definition.

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 whether data definitions are enabled for the Internet server connection.

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 error code value for the last Internet server connection.

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 error code value for the last Internet server connection.

Description

This property indicates error message value for the last Internet server connection.

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
Name of Internet server connection.

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
Name of Internet server connection.

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
Indicates connection string value.

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
Indicates connection string value.

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

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

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 message via the Internet server connection.

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
Gets message via the Internet server connection.

Description

This method gets message via the Internet server connection. The method times out after nTimeOutInMilliseconds if no message is received by the 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 Internet server connection.

Description

This method enables a data definition for the Internet server connection specified by bstrDataDefinitionID. bstrDataDefinitionID is the key to the data definition to be enabled.

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 dataset definition for the Internet server connection.

Description

This method disables a dataset definition for the internet server connection specified by bstrDataDefinitionID. bstrDataDefinitionID is the key to the dataset to be disabled.

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 value for dataset definition in Internet server connection.

Remarks

This method does nothing in the current version.

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 value for dataset definition for Internet server connection.

Description

This method gets value for dataset definition for Internet server connection specified by bstrName.

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 command information via the Internet 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.

getTrackingServicesList

Object getTrackingServicesList()
                               throws IOException,
                                      AutomationException
Lists tracking services within the Internet server connection.

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.

getTrackingService

ITrackingServiceDef getTrackingService(String bstrName)
                                       throws IOException,
                                              AutomationException
Gets tracking service information for the Internet server connection.

Description

This method gets message via the Internet server connection. The method times out after nTimeOutInMilliseconds if no message is received by the 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.ITrackingServiceDef
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

returnTrackingService

void returnTrackingService(ITrackingServiceDef piTrackingServiceDef)
                           throws IOException,
                                  AutomationException
Returns tracking service information for the Internet server connection.

Remarks

This method does nothing in the current version.

Product Availability

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

Parameters:
piTrackingServiceDef - A reference to a com.esri.arcgis.trackinganalyst.ITrackingServiceDef (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSubletPath

String getSubletPath()
                     throws IOException,
                            AutomationException
Value of the sublet path for the Internet server connection.

Product Availability

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

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

setSubletPath

void setSubletPath(String pbstrSubletPath)
                   throws IOException,
                          AutomationException
Value of the sublet path for the Internet server connection.

Product Availability

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

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

getTopicName

String getTopicName(String bstrServiceName)
                    throws IOException,
                           AutomationException
Indicates name for the topic in the Internet server connection.

Product Availability

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

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

setTopicName

void setTopicName(String bstrServiceName,
                  String pbstrTopicName)
                  throws IOException,
                         AutomationException
Indicates name for the topic in the Internet server connection.

Product Availability

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

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

getPortNumber

int getPortNumber()
                  throws IOException,
                         AutomationException
Port number used for the Internet server connection.

Product Availability

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

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

setPortNumber

void setPortNumber(int plPortNumber)
                   throws IOException,
                          AutomationException
Port number used for the Internet server connection.

Product Availability

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

Parameters:
plPortNumber - The plPortNumber (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD