com.esri.arcgis.trackinganalyst
Interface ITxConnectorSetup

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

GeneralTrackingConnector, ITxConnectorSetupProxy

public interface ITxConnectorSetup
extends java.io.Serializable

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

Description: 'Provides access to the methods and properties to setup a tracking connection.' 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	IID9c199c51_f80a_4017_af4c_b25f3ecfd629
static int	xxDummy Deprecated. Internal use only

Method Summary

void	addDataMessage(IDataMessage piMessage) Add a Data Message to the Connectors Queue.
void	addDebugMessage(java.lang.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.
java.lang.String	getConnectionString() Connection string value for the server connection.
int	getErrorCode() Error code of the last error.
java.lang.String	getErrorMessage() Message associated with last error / error code.
java.lang.String	getServerName() Name of the fo server to connect to.
java.lang.String	getUserName() User's login name.
void	removeMessageDef(java.lang.String bstrMessageDefinitionName) Removes a Message Definition from the collection.
void	removeTrackingServiceDef(java.lang.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(java.lang.String pbstrLastErrorMessage) Message associated with last error / error code.
void	setParentByRef(java.lang.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.

Field Detail

IID9c199c51_f80a_4017_af4c_b25f3ecfd629

static final int IID9c199c51_f80a_4017_af4c_b25f3ecfd629

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

addMessageDefinition

void addMessageDefinition(IDatasetDef piMessageDef)
                          throws java.io.IOException,
                                 AutomationException

Add a message definition to the collection.

Parameters:

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

addTrackingServiceDefinition

void addTrackingServiceDefinition(ITrackingServiceDef piServiceDef)
                                  throws java.io.IOException,
                                         AutomationException

Add a tracking service definition to the collection.

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

validateTrackingService

boolean validateTrackingService(ITrackingServiceDef piServiceDef)
                                throws java.io.IOException,
                                       AutomationException

Validate a tracking service within the tracking service collection.

Parameters:

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

Returns:

The pbvarValid

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeTrackingServiceDef

void removeTrackingServiceDef(java.lang.String bstrServiceName)
                              throws java.io.IOException,
                                     AutomationException

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

Parameters:

bstrServiceName - The bstrServiceName (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeMessageDef

void removeMessageDef(java.lang.String bstrMessageDefinitionName)
                      throws java.io.IOException,
                             AutomationException

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

Parameters:

bstrMessageDefinitionName - The bstrMessageDefinitionName (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addDebugMessage

void addDebugMessage(java.lang.String bstrMessage)
                     throws java.io.IOException,
                            AutomationException

Add a Debug Message to the internal Debug log.

Parameters:

bstrMessage - The bstrMessage (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addDataMessage

void addDataMessage(IDataMessage piMessage)
                    throws java.io.IOException,
                           AutomationException

Add a Data Message to the Connectors Queue.

Parameters:

piMessage - A reference to a com.esri.arcgis.geodatabaseextensions.IDataMessage (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getConnectionStatus

int getConnectionStatus()
                        throws java.io.IOException,
                               AutomationException

The Connection State of the object.

Returns:

A com.esri.arcgis.trackinganalyst.enumConnectionStatus constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setConnectionStatus

void setConnectionStatus(int peConnectionStatus)
                         throws java.io.IOException,
                                AutomationException

The Connection State of the object.

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getErrorCode

int getErrorCode()
                 throws java.io.IOException,
                        AutomationException

Error code of the last error.

Returns:

The pdwLastErrorCode

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setErrorCode

void setErrorCode(int pdwLastErrorCode)
                  throws java.io.IOException,
                         AutomationException

Error code of the last error.

Parameters:

pdwLastErrorCode - The pdwLastErrorCode (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getErrorMessage

java.lang.String getErrorMessage()
                                 throws java.io.IOException,
                                        AutomationException

Message associated with last error / error code.

Returns:

The pbstrLastErrorMessage

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setErrorMessage

void setErrorMessage(java.lang.String pbstrLastErrorMessage)
                     throws java.io.IOException,
                            AutomationException

Message associated with last error / error code.

Parameters:

pbstrLastErrorMessage - The pbstrLastErrorMessage (in)

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 of the fo server to connect to.

Returns:

The pbstrServerName

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.

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.

setParentByRef

void setParentByRef(java.lang.Object rhs1)
                    throws java.io.IOException,
                           AutomationException

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

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.