com.esri.arcgis.trackinganalyst
Interface ITxConnectorSetup

All Superinterfaces:

Serializable

All Known Implementing Classes:

GeneralTrackingConnector

public interface ITxConnectorSetup
extends Serializable

Provides access to the methods and properties to setup a tracking connection.

Product Availability

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

Method Summary

void	addDataMessage(IDataMessage piMessage) Add a Data Message to the Connectors Queue.
void	addDebugMessage(String bstrMessage) Add a Debug Message to the internal Debug log.
void	addMessageDefinition(IDatasetDef piMessageDef) Add a message definition to the collection.
void	addTrackingServiceDefinition(ITrackingServiceDef piServiceDef) Add a tracking service definition to the collection.
int	getConnectionStatus() The Connection State of the object.
String	getConnectionString() Connection string value for the server connection.
int	getErrorCode() Error code of the last error.
String	getErrorMessage() Message associated with last error / error code.
String	getServerName() Name of the fo server to connect to.
String	getUserName() User's login name.
void	removeMessageDef(String bstrMessageDefinitionName) Removes a Message Definition from the collection.
void	removeTrackingServiceDef(String bstrServiceName) Removes a Tracking Service Definition from the collection.
void	setConnectionStatus(int peConnectionStatus) The Connection State of the object.
void	setErrorCode(int pdwLastErrorCode) Error code of the last error.
void	setErrorMessage(String pbstrLastErrorMessage) Message associated with last error / error code.
void	setParentByRef(Object rhs1) Assign the parent object so this interface object can communicate with its parent.
boolean	validateTrackingService(ITrackingServiceDef piServiceDef) Validate a tracking service within the tracking service collection.

Method Detail

addMessageDefinition

void addMessageDefinition(IDatasetDef piMessageDef)
                          throws IOException,
                                 AutomationException

Add a message definition to the collection.

Product Availability

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

Parameters:

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

addTrackingServiceDefinition

void addTrackingServiceDefinition(ITrackingServiceDef piServiceDef)
                                  throws IOException,
                                         AutomationException

Add a tracking service definition to the collection.

Product Availability

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

Parameters:

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

validateTrackingService

boolean validateTrackingService(ITrackingServiceDef piServiceDef)
                                throws IOException,
                                       AutomationException

Validate a tracking service within the tracking service collection.

Product Availability

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

Parameters:

piServiceDef - A reference to a com.esri.arcgis.trackinganalyst.ITrackingServiceDef (in)

Returns:

The pbvarValid

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeTrackingServiceDef

void removeTrackingServiceDef(String bstrServiceName)
                              throws IOException,
                                     AutomationException

Removes a Tracking Service Definition from the collection. A * will remove all Tracking Services.

Product Availability

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

Parameters:

bstrServiceName - The bstrServiceName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeMessageDef

void removeMessageDef(String bstrMessageDefinitionName)
                      throws IOException,
                             AutomationException

Removes a Message Definition from the collection. A * will remove all Message definitions.

Product Availability

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

Parameters:

bstrMessageDefinitionName - The bstrMessageDefinitionName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addDebugMessage

void addDebugMessage(String bstrMessage)
                     throws IOException,
                            AutomationException

Add a Debug Message to the internal Debug log.

Product Availability

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

Parameters:

bstrMessage - The bstrMessage (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addDataMessage

void addDataMessage(IDataMessage piMessage)
                    throws IOException,
                           AutomationException

Add a Data Message to the Connectors Queue.

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.IDataMessage (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getConnectionStatus

int getConnectionStatus()
                        throws IOException,
                               AutomationException

The Connection State of the object.

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.

setConnectionStatus

void setConnectionStatus(int peConnectionStatus)
                         throws IOException,
                                AutomationException

The Connection State of the object.

Product Availability

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

Parameters:

peConnectionStatus - A com.esri.arcgis.trackinganalyst.enumConnectionStatus constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getErrorCode

int getErrorCode()
                 throws IOException,
                        AutomationException

Error code of the last error.

Product Availability

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

Returns:

The pdwLastErrorCode

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setErrorCode

void setErrorCode(int pdwLastErrorCode)
                  throws IOException,
                         AutomationException

Error code of the last error.

Product Availability

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

Parameters:

pdwLastErrorCode - The pdwLastErrorCode (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getErrorMessage

String getErrorMessage()
                       throws IOException,
                              AutomationException

Message associated with last error / error code.

Product Availability

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

Returns:

The pbstrLastErrorMessage

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setErrorMessage

void setErrorMessage(String pbstrLastErrorMessage)
                     throws IOException,
                            AutomationException

Message associated with last error / error code.

Product Availability

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

Parameters:

pbstrLastErrorMessage - The pbstrLastErrorMessage (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getServerName

String getServerName()
                     throws IOException,
                            AutomationException

Name of the fo server to connect to.

Product Availability

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

Returns:

The pbstrServerName

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.

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.

setParentByRef

void setParentByRef(Object rhs1)
                    throws IOException,
                           AutomationException

Assign the parent object so this interface object can communicate with its parent.

Product Availability

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

Parameters:

rhs1 - A reference to another Object (IUnknown) (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.