|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IServerConnection
Provides access to the methods and properties for a connector object to connect to a Tracking Server.
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 |
---|
boolean isConnected() throws IOException, AutomationException
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.String getServerName() throws IOException, AutomationException
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setServerName(String pVal) throws IOException, AutomationException
pVal
- The pVal (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.String getUserName() throws IOException, AutomationException
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.boolean isEnableDataFiltering() throws IOException, AutomationException
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setEnableDataFiltering(boolean pbvVal) throws IOException, AutomationException
pbvVal
- The pbvVal (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.Object getDataSetDefinitionList() throws IOException, AutomationException
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.Object getEnabledDataDefinitions() throws IOException, AutomationException
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.int getLastConnectionErrorCode() throws IOException, AutomationException
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.String getLastConnectionErrorMessage() throws IOException, AutomationException
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.String getConnectionName() throws IOException, AutomationException
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setConnectionName(String pbstrConnectionName) throws IOException, AutomationException
pbstrConnectionName
- The pbstrConnectionName (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.String getConnectionString() throws IOException, AutomationException
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setConnectionString(String pbstrConnectionString) throws IOException, AutomationException
pbstrConnectionString
- The pbstrConnectionString (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void connect(String bstrUserName, String bstrPassword) throws IOException, AutomationException
bstrUserName
- The bstrUserName (in)bstrPassword
- The bstrPassword (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void disconnect() throws IOException, AutomationException
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void sendMessage(IMessage piMessage) throws IOException, AutomationException
piMessage
- A reference to a com.esri.arcgis.trackinganalyst.IMessage (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.IMessage getMessage(int nTimeOutInMilliseconds) throws IOException, AutomationException
nTimeOutInMilliseconds
- The nTimeOutInMilliseconds (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void enableDataDefinition(String bstrDataDefinitionID) throws IOException, AutomationException
bstrDataDefinitionID
- The bstrDataDefinitionID (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void disableDataDefinition(String bstrDataDefinitionID) throws IOException, AutomationException
bstrDataDefinitionID
- The bstrDataDefinitionID (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void returnDataSetDefinition(IDatasetDef piDataSetDef) throws IOException, AutomationException
piDataSetDef
- A reference to a com.esri.arcgis.trackinganalyst.IDatasetDef (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.IDatasetDef getDataSetDefinition(String bstrName) throws IOException, AutomationException
bstrName
- The bstrName (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.IResponseMessage sendCommand(ICommandMessage piCmdMsg, int nTimeOut) throws IOException, AutomationException
piCmdMsg
- A reference to a com.esri.arcgis.trackinganalyst.ICommandMessage (in)nTimeOut
- The nTimeOut (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |