com.esri.arcgis.trackinganalyst
Interface IClientConnection

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

IClientConnectionProxy, PlugIn

public interface IClientConnection
extends java.io.Serializable

COM Interface 'IClientConnection'. 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	IIDcc018a0c_24fb_11d4_b34c_00104ba2abcc
static int	xxDummy Deprecated. Internal use only

Method Summary

void	disconnect() Disconnects client connection.
int	getClientQueueCount() Number of connections in client queue.
java.lang.Object	getDataFilters() Defines data filters in client connection.
java.lang.String	getID() Defines data's ID value in client connection.
java.lang.String	getName() Defines dataset name in client connection.
int	getServerQueueCount() Number of connections in server queue.
int	getStatus() Indicates status of the client connection.
java.lang.Object	getTimeEstablished() Indicates time connection was established.
int	getTotalClientMessageCount() Total number of client messages.
int	getTotalServerMessageCount() Total number of server messages.
IMessage	popClientMessage(int nTimeOut) Obtain next message from the client queue.
void	postClientMessage(IMessage piMessage) Post a client message to server queue.
void	setName(java.lang.String pVal) Defines dataset name in client connection.

Field Detail

IIDcc018a0c_24fb_11d4_b34c_00104ba2abcc

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

getDataFilters

java.lang.Object getDataFilters()
                                throws java.io.IOException,
                                       AutomationException

Defines data filters in client connection.

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getID

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

Defines data's ID value in client connection.

Returns:

The pVal

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

Defines dataset name in client 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

Defines dataset name in client connection.

Parameters:

pVal - The pVal (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getServerQueueCount

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

Number of connections in server queue.

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getClientQueueCount

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

Number of connections in client queue.

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTimeEstablished

java.lang.Object getTimeEstablished()
                                    throws java.io.IOException,
                                           AutomationException

Indicates time connection was established.

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTotalServerMessageCount

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

Total number of server messages.

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTotalClientMessageCount

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

Total number of client messages.

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getStatus

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

Indicates status of the client connection.

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.

disconnect

void disconnect()
                throws java.io.IOException,
                       AutomationException

Disconnects client connection.

Throws:

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

AutomationException - If the ArcObject component throws an exception.

postClientMessage

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

Post a client message to server queue.

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.

popClientMessage

IMessage popClientMessage(int nTimeOut)
                          throws java.io.IOException,
                                 AutomationException

Obtain next message from the client queue.

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.