com.esri.arcgis.trackinganalyst
Interface IStatusMessage

All Superinterfaces:
Serializable
All Known Implementing Classes:
StatusMessage

public interface IStatusMessage
extends Serializable

Provides access to methods and properties used to manage status message parameters.

Product Availability

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


Method Summary
 Object getCreationDate()
          Indicates the date of the status message's creation.
 String getDestination()
          Indicates destination of status message.
 int getErrorCode()
          Identifies error code values for the status message.
 String getID()
          ID value for the status message.
 int getMessageType()
          Indicates type of status message.
 String getOrigin()
          Identifies origin value for status message.
 int getPriority()
          Indicates priority of the status message.
 int getStatus()
          Identifies status value of the message.
 void setDestination(String pVal)
          Indicates destination of status message.
 void setErrorCode(int pVal)
          Identifies error code values for the status message.
 void setOrigin(String pVal)
          Identifies origin value for status message.
 void setPriority(int pVal)
          Indicates priority of the status message.
 void setStatus(int pVal)
          Identifies status value of the message.
 

Method Detail

getCreationDate

Object getCreationDate()
                       throws IOException,
                              AutomationException
Indicates the date of the status 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 status 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 status 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 status 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 status 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 status 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 status 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.

getErrorCode

int getErrorCode()
                 throws IOException,
                        AutomationException
Identifies error code values for the status 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.

setErrorCode

void setErrorCode(int pVal)
                  throws IOException,
                         AutomationException
Identifies error code values for the status 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.

getStatus

int getStatus()
              throws IOException,
                     AutomationException
Identifies status value of the 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
Identifies status value of the 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.

getOrigin

String getOrigin()
                 throws IOException,
                        AutomationException
Identifies origin value for status 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.

setOrigin

void setOrigin(String pVal)
               throws IOException,
                      AutomationException
Identifies origin value for status 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.