com.esri.arcgis.trackinganalyst
Interface IResponseMessage

All Superinterfaces:
Serializable
All Known Implementing Classes:
ResponseMessage

public interface IResponseMessage
extends Serializable

Provides access to methods and properties used to access responses from the Tracking Server or datalinks in which a command was issued.

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 response message.
 Object getArgument(int nIndex)
          Gets argument from the response message.
 int getArgumentCount()
          Number of arguments in the response message.
 int getCommandID()
          Identifies command for the response message.
 String getCommandMessageID()
          Indicates ID of the command in the response message.
 Object getCreationDate()
          Indicates the date of the response message's creation.
 String getDestination()
          Indicates destination of the response message.
 int getErrorCode()
          Error code value.
 String getID()
          ID value for the response message.
 int getMessageType()
          Indicates type of response message.
 int getPriority()
          Indicates priority of the response message.
 int getStatus()
          Indicates status of response message.
 void removeArgument(int nIndex)
          Removes an argument from the response message.
 void setArgument(int nIndex, Object pValue)
          Sets an argument for the response message.
 void setDestination(String pVal)
          Indicates destination of the response message.
 void setErrorCode(int pVal)
          Error code value.
 void setPriority(int pVal)
          Indicates priority of the response message.
 void setStatus(int pVal)
          Indicates status of response message.
 

Method Detail

getCreationDate

Object getCreationDate()
                       throws IOException,
                              AutomationException
Indicates the date of the response 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 response 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 response 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 response 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 response 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 response 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 response 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 response 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
Sets an argument for the response 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.

addArgument

void addArgument(Object pValue)
                 throws IOException,
                        AutomationException
Adds an argument to the response 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
Removes an argument from the response 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
Gets argument from the response 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.

getCommandID

int getCommandID()
                 throws IOException,
                        AutomationException
Identifies command for the response 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.

getCommandMessageID

String getCommandMessageID()
                           throws IOException,
                                  AutomationException
Indicates ID of the command in the response 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.

getStatus

int getStatus()
              throws IOException,
                     AutomationException
Indicates status of response message.

Product Availability

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

Returns:
A com.esri.arcgis.trackinganalyst.enumResponseStatus constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setStatus

void setStatus(int pVal)
               throws IOException,
                      AutomationException
Indicates status of response message.

Product Availability

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

Parameters:
pVal - A com.esri.arcgis.trackinganalyst.enumResponseStatus constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getErrorCode

int getErrorCode()
                 throws IOException,
                        AutomationException
Error code value.

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.

setErrorCode

void setErrorCode(int pVal)
                  throws IOException,
                         AutomationException
Error code value.

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.