com.esri.arcgis.trackinganalyst
Interface IDataMessage

All Superinterfaces:

Serializable

All Known Implementing Classes:

DataMessage

public interface IDataMessage
extends Serializable

Provides access to methods and properties used to manage data messages.

Product Availability

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

Method Summary

void	addArgument(Object pValue) Adds an argument to the data message.
void	addColumn(Object pValue) Adds a column to the data message.
Object	getArgument(int nIndex) Gets an argument for the data message.
int	getArgumentCount() Number of arguments in the data message.
Object	getColumn(int nIndex) Returns value for columns in the data message.
int	getColumnCount() Number of columns in data message.
Object	getCreationDate() Indicates date of data message's creation.
String	getDataDefinitionID() ID value for the data definition in the message.
String	getDestination() Indicates destination of the data message.
String	getID() ID value for the data message.
int	getMessageType() Indicates type of data message.
int	getPriority() Indictes priority of data message.
Object	getRawColumn(int nIndex) Returns the Raw column info.
void	removeArgument(int nIndex) Removes an argument from the data message.
void	removeColumn(int nIndex) Removes a column from the data message.
void	setArgument(int nIndex, Object pValue) Sets an argument for the data message.
void	setColumn(int nIndex, Object pValue) Sets the number of columns in a data message.
void	setDataDefinitionID(String pVal) ID value for the data definition in the message.
void	setDestination(String pVal) Indicates destination of the data message.
void	setPriority(int pVal) Indictes priority of data message.

Method Detail

getCreationDate

Object getCreationDate()
                       throws IOException,
                              AutomationException

Indicates date of data message's creation.

Product Availability

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

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getID

String getID()
             throws IOException,
                    AutomationException

ID value for the data message.

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.

getMessageType

int getMessageType()
                   throws IOException,
                          AutomationException

Indicates type of data message.

Product Availability

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

Returns:

A com.esri.arcgis.trackinganalyst.enumMessageType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPriority

int getPriority()
                throws IOException,
                       AutomationException

Indictes priority of data message.

Description

The property indicates priority of data message in queue.

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.

setPriority

void setPriority(int pVal)
                 throws IOException,
                        AutomationException

Indictes priority of data message.

Product Availability

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

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDestination

String getDestination()
                      throws IOException,
                             AutomationException

Indicates destination of the data message.

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.

setDestination

void setDestination(String pVal)
                    throws IOException,
                           AutomationException

Indicates destination of the data message.

Product Availability

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

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getArgumentCount

int getArgumentCount()
                     throws IOException,
                            AutomationException

Number of arguments in the data message.

Description

The ArgumentCount property provides the number of arguments that the message has.

Remarks

Same as ColumnCount.

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.

setArgument

void setArgument(int nIndex,
                 Object pValue)
                 throws IOException,
                        AutomationException

Sets an argument for the data message.

Description

This method sets value for an argument in a message at specified index.

Remarks

Same as setColumn.

Product Availability

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

Parameters:

nIndex - The nIndex (in)

pValue - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addArgument

void addArgument(Object pValue)
                 throws IOException,
                        AutomationException

Adds an argument to the data message.

Description

The addArgument method allows the user to add an argument to the argument list.

Remarks

Same as addColumn.

Product Availability

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

Parameters:

pValue - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeArgument

void removeArgument(int nIndex)
                    throws IOException,
                           AutomationException

Removes an argument from the data message.

Remarks

Same as removeColumn.

Product Availability

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

Parameters:

nIndex - The nIndex (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getArgument

Object getArgument(int nIndex)
                   throws IOException,
                          AutomationException

Gets an argument for the data message.

Description

The getArgument retrieves an argument from the argument list at the user specified index.

Remarks

Same as getColumn.

Product Availability

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

Parameters:

nIndex - The nIndex (in)

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDataDefinitionID

String getDataDefinitionID()
                           throws IOException,
                                  AutomationException

ID value for the data definition in the message.

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.

setDataDefinitionID

void setDataDefinitionID(String pVal)
                         throws IOException,
                                AutomationException

ID value for the data definition in the message.

Product Availability

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

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getColumnCount

int getColumnCount()
                   throws IOException,
                          AutomationException

Number of columns in data message.

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.

setColumn

void setColumn(int nIndex,
               Object pValue)
               throws IOException,
                      AutomationException

Sets the number of columns in a data message.

Product Availability

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

Parameters:

nIndex - The nIndex (in)

pValue - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addColumn

void addColumn(Object pValue)
               throws IOException,
                      AutomationException

Adds a column to the data message.

Product Availability

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

Parameters:

pValue - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeColumn

void removeColumn(int nIndex)
                  throws IOException,
                         AutomationException

Removes a column from the data message.

Product Availability

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

Parameters:

nIndex - The nIndex (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getColumn

Object getColumn(int nIndex)
                 throws IOException,
                        AutomationException

Returns value for columns in the data message.

Description

This method returns value for the column specified by the index in the data message.

Product Availability

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

Parameters:

nIndex - The nIndex (in)

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRawColumn

Object getRawColumn(int nIndex)
                    throws IOException,
                           AutomationException

Returns the Raw column info. For Objects it is a array of bytes conforming to the IPersist Stream format.

Description

This method returns the raw column info. For Objects it is an array of bytes conforming to the IPersist Stream format.

Product Availability

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

Parameters:

nIndex - The nIndex (in)

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.