com.esri.arcgis.trackinganalyst
Class StatusMessage

java.lang.Object
  extended by com.esri.arcgis.trackinganalyst.StatusMessage
All Implemented Interfaces:
com.esri.arcgis.interop.RemoteObjRef, IPersist, IPersistStream, IMessage, IStatusMessage, Externalizable, Serializable

public class StatusMessage
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IStatusMessage, IMessage, IPersistStream, Externalizable

Message reporting status to the Tracking Server.

Product Availability

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

See Also:
Serialized Form

Constructor Summary
StatusMessage()
          Constructs a StatusMessage using ArcGIS Engine.
StatusMessage(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
StatusMessage theStatusMessage = (StatusMessage) obj;
 
Method Summary
 boolean equals(Object o)
          Compare this object with another
 void getClassID(GUID[] pClassID)
          getClassID
static String getClsid()
          getClsid.
 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.
 void getSizeMax(_ULARGE_INTEGER[] pcbSize)
          getSizeMax
 int getStatus()
          Identifies status value of the message.
 int hashCode()
          the hashcode for this object
 void isDirty()
          isDirty
 void load(IStream pstm)
          load
 void readExternal(ObjectInput in)
           
 void save(IStream pstm, int fClearDirty)
          save
 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.
 void writeExternal(ObjectOutput out)
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef
getJintegraDispatch, release
 

Constructor Detail

StatusMessage

public StatusMessage()
              throws IOException,
                     UnknownHostException
Constructs a StatusMessage using ArcGIS Engine.

Throws:
IOException - if there are interop problems
UnknownHostException - if there are interop problems

StatusMessage

public StatusMessage(Object obj)
              throws IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
StatusMessage theStatusMessage = (StatusMessage) obj;

Construct a StatusMessage using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to StatusMessage.

Parameters:
obj - an object returned from ArcGIS Engine or Server
Throws:
IOException - if there are interop problems
Method Detail

getClsid

public static String getClsid()
getClsid.


equals

public boolean equals(Object o)
Compare this object with another

Overrides:
equals in class Object

hashCode

public int hashCode()
the hashcode for this object

Overrides:
hashCode in class Object

getCreationDate

public 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.

Specified by:
getCreationDate in interface IMessage
Specified by:
getCreationDate in interface IStatusMessage
Returns:
A Variant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getID

public 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.

Specified by:
getID in interface IMessage
Specified by:
getID in interface IStatusMessage
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMessageType

public 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.

Specified by:
getMessageType in interface IMessage
Specified by:
getMessageType in interface IStatusMessage
Returns:
A com.esri.arcgis.trackinganalyst.enumMessageType constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPriority

public 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.

Specified by:
getPriority in interface IMessage
Specified by:
getPriority in interface IStatusMessage
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPriority

public 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.

Specified by:
setPriority in interface IMessage
Specified by:
setPriority in interface IStatusMessage
Parameters:
pVal - The pVal (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDestination

public 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.

Specified by:
getDestination in interface IMessage
Specified by:
getDestination in interface IStatusMessage
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDestination

public 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.

Specified by:
setDestination in interface IMessage
Specified by:
setDestination in interface IStatusMessage
Parameters:
pVal - The pVal (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getErrorCode

public 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.

Specified by:
getErrorCode in interface IStatusMessage
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setErrorCode

public 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.

Specified by:
setErrorCode in interface IStatusMessage
Parameters:
pVal - The pVal (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getStatus

public 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.

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

setStatus

public 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.

Specified by:
setStatus in interface IStatusMessage
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

public 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.

Specified by:
getOrigin in interface IStatusMessage
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setOrigin

public 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.

Specified by:
setOrigin in interface IStatusMessage
Parameters:
pVal - The pVal (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws IOException,
                    AutomationException
isDirty

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
isDirty in interface IPersistStream
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws IOException,
                 AutomationException
load

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
load in interface IPersistStream
Parameters:
pstm - A reference to a com.esri.arcgis.system.IStream (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws IOException,
                 AutomationException
save

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
save in interface IPersistStream
Parameters:
pstm - A reference to a com.esri.arcgis.system.IStream (in)
fClearDirty - The fClearDirty (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws IOException,
                       AutomationException
getSizeMax

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getSizeMax in interface IPersistStream
Parameters:
pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getClassID

public void getClassID(GUID[] pClassID)
                throws IOException,
                       AutomationException
getClassID

Description

IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getClassID in interface IPersist
Parameters:
pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException
Specified by:
writeExternal in interface Externalizable
Throws:
IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException
Specified by:
readExternal in interface Externalizable
Throws:
IOException
ClassNotFoundException