com.esri.arcgis.trackinganalyst
Interface IPlugin

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

IPluginProxy, PlugIn

public interface IPlugin
extends java.io.Serializable

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

Description: 'Provides access to methods and properties that data links provide to the Tracking Server so they can be 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	IIDcc018a10_24fb_11d4_b34c_00104ba2abcc
static int	xxDummy Deprecated. Internal use only

Method Summary

void	disableDataDefinition(java.lang.String bstrDataDefinitionID) Disables data definition for the data link.
void	disconnect() Disconnects data link.
void	enableDataDefinition(java.lang.String bstrDataDefinitionID) Enables data definition for the data link.
int	getClientQueueCount() Number of messages in the client queue.waiting to be read by the client object or system of this data link.
java.lang.Object	getDataFilters() An array of Dataset Definition IDs that are currently Allowed to be read by the plugin when data filtering is enabled.
IDatasetDef	getDataSetDefinition(java.lang.String bstrName) Gets dataset definition information for the data link.
java.lang.Object	getDataSetDefinitionList() An array of all dataset defintion names that are defined in the TrackingServer that the data link is connected to.
java.lang.String	getID() Unique identifier of the current instance of the data link.
java.lang.String	getName() Name of data link plugin.
int	getServerQueueCount() Number of messages waiting to be published to the server.
int	getStatus() Indicates status of the data link plugin.
java.lang.Object	getTimeEstablished() Indicates the time the data link plugin was established.
int	getTotalClientMessageCount() Total number of client messages in the data link plugin.
int	getTotalServerMessageCount() Total number of server messages in the data link plugin.
boolean	isEnableDataFiltering() Indicates whether data filtering is enabled for the data link.
IMessage	popClientMessage(int nTimeOut) Retrieves a client message from the data link.
void	postClientMessage(IMessage piMessage) Posts a client message to the data link.
void	returnDataSetDefinition(IDatasetDef piDataSetDef) Returns dataset definition information for the dta link.
IResponseMessage	sendCommand(ICommandMessage piCmdMsg, int nTimeOut) Sends a command to the data link.
void	setEnableDataFiltering(boolean pbvVal) Indicates whether data filtering is enabled for the data link.
void	setName(java.lang.String pVal) Name of data link plugin.

Field Detail

IIDcc018a10_24fb_11d4_b34c_00104ba2abcc

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

An array of Dataset Definition IDs that are currently Allowed to be read by the plugin when data filtering is enabled.

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

Unique identifier of the current instance of the data link.

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

Name of data link plugin.

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 data link plugin.

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 messages waiting to be published to the server.

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 messages in the client queue.waiting to be read by the client object or system of this data link.

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 the time the data link plugin 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 in the data link plugin.

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 in the data link plugin.

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 data link plugin.

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 data link.

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

Posts a client message to the data link.

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

Retrieves a client message from the data link.

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.

getDataSetDefinitionList

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

An array of all dataset defintion names that are defined in the TrackingServer that the data link is connected to.

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isEnableDataFiltering

boolean isEnableDataFiltering()
                              throws java.io.IOException,
                                     AutomationException

Indicates whether data filtering is enabled for the data link.

Returns:

The pbvVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setEnableDataFiltering

void setEnableDataFiltering(boolean pbvVal)
                            throws java.io.IOException,
                                   AutomationException

Indicates whether data filtering is enabled for the data link.

Parameters:

pbvVal - The pbvVal (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

enableDataDefinition

void enableDataDefinition(java.lang.String bstrDataDefinitionID)
                          throws java.io.IOException,
                                 AutomationException

Enables data definition for the data link.

Parameters:

bstrDataDefinitionID - The bstrDataDefinitionID (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

disableDataDefinition

void disableDataDefinition(java.lang.String bstrDataDefinitionID)
                           throws java.io.IOException,
                                  AutomationException

Disables data definition for the data link.

Parameters:

bstrDataDefinitionID - The bstrDataDefinitionID (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

returnDataSetDefinition

void returnDataSetDefinition(IDatasetDef piDataSetDef)
                             throws java.io.IOException,
                                    AutomationException

Returns dataset definition information for the dta link.

Parameters:

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

getDataSetDefinition

IDatasetDef getDataSetDefinition(java.lang.String bstrName)
                                 throws java.io.IOException,
                                        AutomationException

Gets dataset definition information for the data link.

Parameters:

bstrName - The bstrName (in)

Returns:

A reference to a com.esri.arcgis.trackinganalyst.IDatasetDef

Throws:

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

AutomationException - If the ArcObject component throws an exception.

sendCommand

IResponseMessage sendCommand(ICommandMessage piCmdMsg,
                             int nTimeOut)
                             throws java.io.IOException,
                                    AutomationException

Sends a command to the data link.

Parameters:

piCmdMsg - A reference to a com.esri.arcgis.trackinganalyst.ICommandMessage (in)

nTimeOut - The nTimeOut (in)

Returns:

A reference to a com.esri.arcgis.trackinganalyst.IResponseMessage

Throws:

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

AutomationException - If the ArcObject component throws an exception.