com.esri.arcgis.trackinganalyst
Interface ICOMClient

All Superinterfaces:

java.io.Serializable

All Known Subinterfaces:

ICOMClient2

All Known Implementing Classes:

ICOMClient2Proxy, ICOMClientProxy, PlugIn

public interface ICOMClient
extends java.io.Serializable

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

Description: 'Provides access to methods and properties implemented by datalinks and consumed by the 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	IIDcc018a0d_24fb_11d4_b34c_00104ba2abcc
static int	xxDummy Deprecated. Internal use only

Method Summary

void	connect(java.lang.String szConnectionString) Connects the client to the Tracking Server.
int	getErrorCode() Value for the error code in the data connection.
int	getEventHandle() The handle to the event that is signaled when data is ready to be received.
java.lang.String	getID() ID value for the data in the connection.
IMessage	getMessage(int nTimeOut) Returns a message from the Tracking Server.
java.lang.String	getName() Name of the dataset in the connection.
void	postMessage(IMessage piMessage) Posts a message to the Tracking Server.
void	setErrorCode(int pVal) Value for the error code in the data connection.
void	setID(java.lang.String pVal) ID value for the data in the connection.
void	setName(java.lang.String pVal) Name of the dataset in the connection.

Field Detail

IIDcc018a0d_24fb_11d4_b34c_00104ba2abcc

static final int IIDcc018a0d_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

getID

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

ID value for the data in the connection.

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setID

void setID(java.lang.String pVal)
           throws java.io.IOException,
                  AutomationException

ID value for the data in the connection.

Parameters:

pVal - The pVal (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getEventHandle

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

The handle to the event that is signaled when data is ready to be received.

Returns:

The pVal

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

Value for the error code in the data connection.

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setErrorCode

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

Value for the error code in the data connection.

Parameters:

pVal - The pVal (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getName

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

Name of the dataset in the connection.

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setName

void setName(java.lang.String pVal)
             throws java.io.IOException,
                    AutomationException

Name of the dataset in the connection.

Parameters:

pVal - The pVal (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

postMessage

void postMessage(IMessage piMessage)
                 throws java.io.IOException,
                        AutomationException

Posts a message to the Tracking Server.

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 nTimeOut)
                    throws java.io.IOException,
                           AutomationException

Returns a message from the Tracking Server.

Parameters:

nTimeOut - The nTimeOut (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.

connect

void connect(java.lang.String szConnectionString)
             throws java.io.IOException,
                    AutomationException

Connects the client to the Tracking Server.

Parameters:

szConnectionString - The szConnectionString (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.