com.esri.arcgis.trackinganalyst
Interface IArguments

All Superinterfaces:

Serializable

All Known Implementing Classes:

CommandMessage, DataMessage, ResponseMessage

public interface IArguments
extends Serializable

Provides access to methods and properties used to manage arguments in a message.

Description

This interface provides a common set of methods used to manage a Tracking Message Objects argument collection.

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 a message.
Object	getArgument(int nIndex) Returns an argument from a message.
int	getArgumentCount() Number of arguments in a message.
Object	getCreationDate() Date of data's creation.
String	getDestination() Destination for incoming message.
String	getID() ID value for dataset.
int	getMessageType() Indicates type of data message.
int	getPriority() Priority of data in queue.
void	removeArgument(int nIndex) Removes an argument from a message.
void	setArgument(int nIndex, Object pValue) Sets value for an argument in a message.
void	setDestination(String pVal) Destination for incoming message.
void	setPriority(int pVal) Priority of data in queue.

Method Detail

getCreationDate

Object getCreationDate()
                       throws IOException,
                              AutomationException

Date of data's creation.

Description

The property provides access to the date of data’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 dataset.

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.geodatabaseextensions.enumMessageType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPriority

int getPriority()
                throws IOException,
                       AutomationException

Priority of data 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

Priority of data in queue.

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

Destination for incoming 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

Destination for incoming 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 a message.

Description

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

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 value for an argument in a message.

Description

The setArgument method sets an argument at the user-specified position with the value given.

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 a message.

Description

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

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 a message.

Description

The removeArgument method removes an argument from the argument list at the user specified index.

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

Returns an argument from a message.

Description

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

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.