com.esri.arcgis.trackinganalyst
Interface ICommandMessage

All Superinterfaces:

Serializable

All Known Implementing Classes:

CommandMessage

public interface ICommandMessage
extends Serializable

Provides access to methods and properties used to build command messages issuing command requests to the Tracking Server or any connected data links.

Product Availability

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

Method Summary

void	addArgument(Object pValue) Add an argument to the command message.
IResponseMessage	createResponseMessage() Creates a response message.
Object	getArgument(int nIndex) Get argument for the command message.
int	getArgumentCount() Number of arguments in the command message.
int	getCommandID() ID value for the command.
Object	getCreationDate() Indicates date of the message's creation.
String	getDestination() Indicates destination of the command message.
String	getID() ID value for the command message.
int	getMessageType() Indicates type of command message.
int	getPriority() Indicates priority of the command message.
String	getRequestor() Property Requestor.
int	getTimeOut() Timeout value for the command message.
void	removeArgument(int nIndex) Remove an argument from the command message.
void	setArgument(int nIndex, Object pValue) Set the argument for the command message.
void	setCommandID(int pVal) ID value for the command.
void	setDestination(String pVal) Indicates destination of the command message.
void	setPriority(int pVal) Indicates priority of the command message.
void	setRequestor(String pVal) Property Requestor.
void	setTimeOut(int pVal) Timeout value for the command message.

Method Detail

getCreationDate

Object getCreationDate()
                       throws IOException,
                              AutomationException

Indicates date of the 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 command 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 command 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

Indicates priority of the command 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.

setPriority

void setPriority(int pVal)
                 throws IOException,
                        AutomationException

Indicates priority of the command 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 command 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 command 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 command 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.

setArgument

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

Set the argument for the command message.

Description

This method sets the argument for the command message at the specified index.

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

Add an argument to the command 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.

removeArgument

void removeArgument(int nIndex)
                    throws IOException,
                           AutomationException

Remove an argument from the command 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.

getArgument

Object getArgument(int nIndex)
                   throws IOException,
                          AutomationException

Get argument for the command 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.

getRequestor

String getRequestor()
                    throws IOException,
                           AutomationException

Property Requestor.

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.

setRequestor

void setRequestor(String pVal)
                  throws IOException,
                         AutomationException

Property Requestor.

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.

getCommandID

int getCommandID()
                 throws IOException,
                        AutomationException

ID value for the command.

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.

setCommandID

void setCommandID(int pVal)
                  throws IOException,
                         AutomationException

ID value for the command.

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.

getTimeOut

int getTimeOut()
               throws IOException,
                      AutomationException

Timeout value for the command 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.

setTimeOut

void setTimeOut(int pVal)
                throws IOException,
                       AutomationException

Timeout value for the command 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.

createResponseMessage

IResponseMessage createResponseMessage()
                                       throws IOException,
                                              AutomationException

Creates a response message.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.