com.esri.arcgis.trackinganalyst
Interface ICommandMessage

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

CommandMessage, ICommandMessageProxy

public interface ICommandMessage

extends java.io.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(java.lang.Object pValue) Add an argument to the command message.
IResponseMessage	createResponseMessage() Creates a response message.
java.lang.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.
java.lang.Object	getCreationDate() Indicates date of the message's creation.
java.lang.String	getDestination() Indicates destination of the command message.
java.lang.String	getID() ID value for the command message.
int	getMessageType() Indicates type of command message.
int	getPriority() Indicates priority of the command message.
java.lang.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, java.lang.Object pValue) Set the argument for the command message.
void	setCommandID(int pVal) ID value for the command.
void	setDestination(java.lang.String pVal) Indicates destination of the command message.
void	setPriority(int pVal) Indicates priority of the command message.
void	setRequestor(java.lang.String pVal) Property Requestor.
void	setTimeOut(int pVal) Timeout value for the command message.

Method Detail

getCreationDate

public java.lang.Object getCreationDate()
                                 throws java.io.IOException,
                                        AutomationException

Indicates date of the message's creation.

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getID

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

ID value for the command message.

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMessageType

public int getMessageType()
                   throws java.io.IOException,
                          AutomationException

Indicates type of command message.

Returns:

A com.esri.arcgis.trackinganalyst.enumMessageType constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPriority

public int getPriority()
                throws java.io.IOException,
                       AutomationException

Indicates priority of the command message.

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setPriority

public void setPriority(int pVal)
                 throws java.io.IOException,
                        AutomationException

Indicates priority of the command message.

Parameters:

pVal - The pVal (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDestination

public java.lang.String getDestination()
                                throws java.io.IOException,
                                       AutomationException

Indicates destination of the command message.

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDestination

public void setDestination(java.lang.String pVal)
                    throws java.io.IOException,
                           AutomationException

Indicates destination of the command message.

Parameters:

pVal - The pVal (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getArgumentCount

public int getArgumentCount()
                     throws java.io.IOException,
                            AutomationException

Number of arguments in the command message.

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setArgument

public void setArgument(int nIndex,
                        java.lang.Object pValue)
                 throws java.io.IOException,
                        AutomationException

Set the argument for the command message.

Parameters:

nIndex - The nIndex (in)

pValue - A Variant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addArgument

public void addArgument(java.lang.Object pValue)
                 throws java.io.IOException,
                        AutomationException

Add an argument to the command message.

Parameters:

pValue - A Variant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

removeArgument

public void removeArgument(int nIndex)
                    throws java.io.IOException,
                           AutomationException

Remove an argument from the command message.

Parameters:

nIndex - The nIndex (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getArgument

public java.lang.Object getArgument(int nIndex)
                             throws java.io.IOException,
                                    AutomationException

Get argument for the command message.

Parameters:

nIndex - The nIndex (in)

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getRequestor

public java.lang.String getRequestor()
                              throws java.io.IOException,
                                     AutomationException

Property Requestor.

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setRequestor

public void setRequestor(java.lang.String pVal)
                  throws java.io.IOException,
                         AutomationException

Property Requestor.

Parameters:

pVal - The pVal (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCommandID

public int getCommandID()
                 throws java.io.IOException,
                        AutomationException

ID value for the command.

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCommandID

public void setCommandID(int pVal)
                  throws java.io.IOException,
                         AutomationException

ID value for the command.

Parameters:

pVal - The pVal (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTimeOut

public int getTimeOut()
               throws java.io.IOException,
                      AutomationException

Timeout value for the command message.

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTimeOut

public void setTimeOut(int pVal)
                throws java.io.IOException,
                       AutomationException

Timeout value for the command message.

Parameters:

pVal - The pVal (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

createResponseMessage

public IResponseMessage createResponseMessage()
                                       throws java.io.IOException,
                                              AutomationException

Creates a response message.

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.