com.esri.arcgis.trackinganalyst
Interface IServerConnection

All Superinterfaces:
java.io.Serializable
All Known Implementing Classes:
GeneralTrackingConnector, InternetConnection, IServerConnectionProxy, ServerConnection

public interface IServerConnection
extends java.io.Serializable

COM Interface 'IServerConnection'. Generated 3/19/2015 1:20:59 PM from 'C:\ArcGIS\COM\esriTrackingAnalyst.olb'

Description: 'Provides access to the methods and properties for a connector object to connect to a Tracking Server.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =


Field Summary
static java.lang.String IID
          Deprecated. Internal use only
static int IIDcc018a11_24fb_11d4_b34c_00104ba2abcc
           
static int xxDummy
          Deprecated. Internal use only
 
Method Summary
 void connect(java.lang.String bstrUserName, java.lang.String bstrPassword)
          Creates connection to the server.
 void disableDataDefinition(java.lang.String bstrDataDefinitionID)
          Disables data definition for the server connection.
 void disconnect()
          Disconnects connection from the server.
 void enableDataDefinition(java.lang.String bstrDataDefinitionID)
          Enables data definition for the server connection.
 java.lang.String getConnectionName()
          Indicates the name of the connection to the server.
 java.lang.String getConnectionString()
          Connection string value for the server connection.
 IDatasetDef getDataSetDefinition(java.lang.String bstrName)
          Gets dataset definition information for the server connection.
 java.lang.Object getDataSetDefinitionList()
          Lists the dataset definition information for the connection.
 java.lang.Object getEnabledDataDefinitions()
          Indicates which data definitions are enabled.
 int getLastConnectionErrorCode()
          Indicates the error code for the last connection to the server.
 java.lang.String getLastConnectionErrorMessage()
          Indicates the error message for the last connection to the server.
 IMessage getMessage(int nTimeOutInMilliseconds)
          Retrieves a message from the server connection.
 java.lang.String getServerName()
          Name for the server.
 java.lang.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(java.lang.String pbstrConnectionName)
          Indicates the name of the connection to the server.
 void setConnectionString(java.lang.String pbstrConnectionString)
          Connection string value for the server connection.
 void setEnableDataFiltering(boolean pbvVal)
          Indicates whether data filtering is enabled for the connection.
 void setServerName(java.lang.String pVal)
          Name for the server.
 

Field Detail

IIDcc018a11_24fb_11d4_b34c_00104ba2abcc

static final int IIDcc018a11_24fb_11d4_b34c_00104ba2abcc
See Also:
Constant Field Values

xxDummy

static final int xxDummy
Deprecated. Internal use only
See Also:
Constant Field Values

IID

static final java.lang.String IID
Deprecated. Internal use only
See Also:
Constant Field Values
Method Detail

isConnected

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

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

getServerName

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

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

setServerName

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

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

getUserName

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

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

isEnableDataFiltering

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

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

setEnableDataFiltering

void setEnableDataFiltering(boolean pbvVal)
                            throws java.io.IOException,
                                   AutomationException
Indicates whether data filtering is enabled for the connection.

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

getDataSetDefinitionList

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

Returns:
A Variant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getEnabledDataDefinitions

java.lang.Object getEnabledDataDefinitions()
                                           throws java.io.IOException,
                                                  AutomationException
Indicates which data definitions are enabled.

Returns:
A Variant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLastConnectionErrorCode

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

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

getLastConnectionErrorMessage

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

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

getConnectionName

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

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

setConnectionName

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

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

getConnectionString

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

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

setConnectionString

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

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

connect

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

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

disconnect

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

Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

sendMessage

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

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

getMessage

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

Parameters:
nTimeOutInMilliseconds - The nTimeOutInMilliseconds (in)
Returns:
A reference to a com.esri.arcgis.trackinganalyst.IMessage
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

enableDataDefinition

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

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

disableDataDefinition

void disableDataDefinition(java.lang.String bstrDataDefinitionID)
                           throws java.io.IOException,
                                  AutomationException
Disables data definition for the server connection.

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

returnDataSetDefinition

void returnDataSetDefinition(IDatasetDef piDataSetDef)
                             throws java.io.IOException,
                                    AutomationException
Returns dataset definition information for the server connection.

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

getDataSetDefinition

IDatasetDef getDataSetDefinition(java.lang.String bstrName)
                                 throws java.io.IOException,
                                        AutomationException
Gets dataset definition information for the server connection.

Parameters:
bstrName - The bstrName (in)
Returns:
A reference to a com.esri.arcgis.trackinganalyst.IDatasetDef
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

sendCommand

IResponseMessage sendCommand(ICommandMessage piCmdMsg,
                             int nTimeOut)
                             throws java.io.IOException,
                                    AutomationException
Sends a command to the server connection.

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:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.