com.esri.arcgis.trackinganalyst
Class CommandMessage

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

public class CommandMessage
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, ICommandMessage, IArguments, IMessage, IPersistStream, Externalizable

Message containing commands for the Tracking Server.

Product Availability

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

See Also:
Serialized Form

Constructor Summary
CommandMessage()
          Constructs a CommandMessage using ArcGIS Engine.
CommandMessage(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
CommandMessage theCommandMessage = (CommandMessage) obj;
 
Method Summary
 void addArgument(Object pValue)
          Add an argument to the command message.
 IResponseMessage createResponseMessage()
          Creates a response message.
 boolean equals(Object o)
          Compare this object with another
 Object getArgument(int nIndex)
          Get argument for the command message.
 int getArgumentCount()
          Number of arguments in the command message.
 void getClassID(GUID[] pClassID)
          getClassID
static String getClsid()
          getClsid.
 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.
 void getSizeMax(_ULARGE_INTEGER[] pcbSize)
          getSizeMax
 int getTimeOut()
          Timeout value for the command message.
 int hashCode()
          the hashcode for this object
 void isDirty()
          isDirty
 void load(IStream pstm)
          load
 void readExternal(ObjectInput in)
           
 void removeArgument(int nIndex)
          Remove an argument from the command message.
 void save(IStream pstm, int fClearDirty)
          save
 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.
 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

CommandMessage

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

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

CommandMessage

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

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

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 date of the message's creation.

Product Availability

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

Specified by:
getCreationDate in interface IArguments
Specified by:
getCreationDate in interface ICommandMessage
Specified by:
getCreationDate in interface IMessage
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 command message.

Product Availability

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

Specified by:
getID in interface IArguments
Specified by:
getID in interface ICommandMessage
Specified by:
getID in interface IMessage
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 command message.

Product Availability

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

Specified by:
getMessageType in interface IArguments
Specified by:
getMessageType in interface ICommandMessage
Specified by:
getMessageType in interface IMessage
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 command message.

Product Availability

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

Specified by:
getPriority in interface IArguments
Specified by:
getPriority in interface ICommandMessage
Specified by:
getPriority in interface IMessage
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 command message.

Product Availability

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

Specified by:
setPriority in interface IArguments
Specified by:
setPriority in interface ICommandMessage
Specified by:
setPriority in interface IMessage
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 the command message.

Product Availability

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

Specified by:
getDestination in interface IArguments
Specified by:
getDestination in interface ICommandMessage
Specified by:
getDestination in interface IMessage
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 the command message.

Product Availability

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

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

getArgumentCount

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

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

setArgument

public void setArgument(int nIndex,
                        Object pValue)
                 throws IOException,
                        AutomationException
Set the argument for the command message.

Product Availability

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

Specified by:
setArgument in interface IArguments
Specified by:
setArgument in interface ICommandMessage
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

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

Specified by:
addArgument in interface IArguments
Specified by:
addArgument in interface ICommandMessage
Parameters:
pValue - A Variant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

removeArgument

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

Specified by:
removeArgument in interface IArguments
Specified by:
removeArgument in interface ICommandMessage
Parameters:
nIndex - The nIndex (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getArgument

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

Specified by:
getArgument in interface IArguments
Specified by:
getArgument in interface ICommandMessage
Parameters:
nIndex - The nIndex (in)
Returns:
A Variant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRequestor

public String getRequestor()
                    throws IOException,
                           AutomationException
Property Requestor.

Product Availability

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

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

setRequestor

public void setRequestor(String pVal)
                  throws IOException,
                         AutomationException
Property Requestor.

Product Availability

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

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

getCommandID

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

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

setCommandID

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

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

getTimeOut

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

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

setTimeOut

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

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

createResponseMessage

public IResponseMessage createResponseMessage()
                                       throws IOException,
                                              AutomationException
Creates a response message.

Product Availability

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

Specified by:
createResponseMessage in interface ICommandMessage
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.

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