com.esri.arcgis.trackinganalyst
Class CommandMessage

java.lang.Object
  com.esri.arcgis.trackinganalyst.CommandMessage

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, IDocumentVersionSupportGEN, IPersist, IPersistStream, ISupportErrorInfo, IArguments, ICommandMessage, IMessage, java.io.Externalizable, java.io.Serializable

public class CommandMessage
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, ICommandMessage, IArguments, IMessage, IPersistStream, ISupportErrorInfo, IDocumentVersionSupportGEN, java.io.Externalizable

COM Class 'CommandMessage'. Generated 3/19/2015 1:20:45 PM from 'C:\ArcGIS\COM\esriTrackingAnalyst.olb'

Description 'Message containing commands for the Tracking Server.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

See Also:

Serialized Form

Field Summary

static long

serialVersionUID

Fields inherited from interface com.esri.arcgis.trackinganalyst.ICommandMessage

IID, IIDcc018a03_24fb_11d4_b34c_00104ba2abcc, xxDummy

Fields inherited from interface com.esri.arcgis.trackinganalyst.IArguments

IID, IIDcc018a00_24fb_11d4_b34c_00104ba2abcc, xxDummy

Fields inherited from interface com.esri.arcgis.trackinganalyst.IMessage

IID, IIDcc018a01_24fb_11d4_b34c_00104ba2abcc, xxDummy

Fields inherited from interface com.esri.arcgis.system.IPersistStream

IID, IID00000109_0000_0000_c000_000000000046, xxDummy

Fields inherited from interface com.esri.arcgis.system.IPersist

IID0000010c_0000_0000_c000_000000000046

Fields inherited from interface com.esri.arcgis.system.ISupportErrorInfo

IID, IIDdf0b3d60_548f_101b_8e65_08002b2bd119, xxDummy

Constructor Summary

CommandMessage()
Constructs a CommandMessage using ArcGIS Engine.

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

Method Summary

void	addArgument(java.lang.Object pValue) Add an argument to the command message.
java.lang.Object	convertToSupportedObject(int docVersion) Convert the object to another object that is supported.
IResponseMessage	createResponseMessage() Creates a response message.
boolean	equals(java.lang.Object o) Compare this object with another
java.lang.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 java.lang.String	getClsid() getClsid.
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.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
int	getMessageType() Indicates type of command message.
int	getPriority() Indicates priority of the command message.
java.lang.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	interfaceSupportsErrorInfo(GUID riid) interfaceSupportsErrorInfo
void	isDirty() isDirty
boolean	isSupportedAtVersion(int docVersion) Is this object valid at the given document version.
void	load(IStream pstm) load
void	readExternal(java.io.ObjectInput in)
void	release() Release a CommandMessage.
void	removeArgument(int nIndex) Remove an argument from the command message.
void	save(IStream pstm, int fClearDirty) save
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.
void	writeExternal(java.io.ObjectOutput out)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

CommandMessage

public CommandMessage()
               throws java.io.IOException,
                      java.net.UnknownHostException

Constructs a CommandMessage using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

CommandMessage

public CommandMessage(java.lang.Object obj)
               throws java.io.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:

java.io.IOException - if there are interop problems

Method Detail

getClsid

public static java.lang.String getClsid()

getClsid.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()

Deprecated. Internal use only.

Specified by:

getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

release

public void release()

Release a CommandMessage.

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

getCreationDate

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

Indicates date of the message's creation.

Specified by:

getCreationDate in interface IArguments

Specified by:

getCreationDate in interface ICommandMessage

Specified by:

getCreationDate in interface IMessage

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.

Specified by:

getID in interface IArguments

Specified by:

getID in interface ICommandMessage

Specified by:

getID in interface IMessage

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.

Specified by:

getMessageType in interface IArguments

Specified by:

getMessageType in interface ICommandMessage

Specified by:

getMessageType in interface IMessage

Returns:

A com.esri.arcgis.geodatabaseextensions.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.

Specified by:

getPriority in interface IArguments

Specified by:

getPriority in interface ICommandMessage

Specified by:

getPriority in interface IMessage

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.

Specified by:

setPriority in interface IArguments

Specified by:

setPriority in interface ICommandMessage

Specified by:

setPriority in interface IMessage

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.

Specified by:

getDestination in interface IArguments

Specified by:

getDestination in interface ICommandMessage

Specified by:

getDestination in interface IMessage

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.

Specified by:

setDestination in interface IArguments

Specified by:

setDestination in interface ICommandMessage

Specified by:

setDestination in interface IMessage

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.

Specified by:

getArgumentCount in interface IArguments

Specified by:

getArgumentCount in interface ICommandMessage

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.

Specified by:

setArgument in interface IArguments

Specified by:

setArgument in interface ICommandMessage

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.

Specified by:

addArgument in interface IArguments

Specified by:

addArgument in interface ICommandMessage

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.

Specified by:

removeArgument in interface IArguments

Specified by:

removeArgument in interface ICommandMessage

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.

Specified by:

getArgument in interface IArguments

Specified by:

getArgument in interface ICommandMessage

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.

Specified by:

getRequestor in interface ICommandMessage

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.

Specified by:

setRequestor in interface ICommandMessage

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.

Specified by:

getCommandID in interface ICommandMessage

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.

Specified by:

setCommandID in interface ICommandMessage

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.

Specified by:

getTimeOut in interface ICommandMessage

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.

Specified by:

setTimeOut in interface ICommandMessage

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.

Specified by:

createResponseMessage in interface ICommandMessage

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.

isDirty

public void isDirty()
             throws java.io.IOException,
                    AutomationException

isDirty

Specified by:

isDirty in interface IPersistStream

Throws:

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

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws java.io.IOException,
                 AutomationException

load

Specified by:

load in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

save

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

save

Specified by:

save in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

fClearDirty - The fClearDirty (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSizeMax

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

getSizeMax

Specified by:

getSizeMax in interface IPersistStream

Parameters:

pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getClassID

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

getClassID

Specified by:

getClassID in interface IPersist

Parameters:

pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws java.io.IOException,
                                       AutomationException

interfaceSupportsErrorInfo

Specified by:

interfaceSupportsErrorInfo in interface ISupportErrorInfo

Parameters:

riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isSupportedAtVersion

public boolean isSupportedAtVersion(int docVersion)
                             throws java.io.IOException,
                                    AutomationException

Is this object valid at the given document version.

Remarks

Use IsSupportedAtVersion to identify if a particular object should be saved to the ObjectStream. This result is based on the esriArcGISVersion enumeration. In some instances, if the object is not supported at a particular ArcGIS version, the object may support conversion to another similar object; use IDocumentVersionSupportGEN::ConvertToSupportedObject to accomplish this.

Product Availability

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

Specified by:

isSupportedAtVersion in interface IDocumentVersionSupportGEN

Parameters:

docVersion - A com.esri.arcgis.system.esriArcGISVersion constant (in)

Returns:

The supported

Throws:

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

AutomationException - If the ArcObject component throws an exception.

convertToSupportedObject

public java.lang.Object convertToSupportedObject(int docVersion)
                                          throws java.io.IOException,
                                                 AutomationException

Convert the object to another object that is supported.

Remarks

This method should be used when IDocumentVersionSupportGEN::IsSupportedAtVersion returns FALSE. Calling ConvertToSupportedObject will return an IUnknown pointer to a relevant object supported at the particular ArcGIS version. Not all objects will return a supported object; in these cases a null pointer will be returned.

Product Availability

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

Specified by:

convertToSupportedObject in interface IDocumentVersionSupportGEN

Parameters:

docVersion - A com.esri.arcgis.system.esriArcGISVersion constant (in)

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Specified by:

writeExternal in interface java.io.Externalizable

Throws:

java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Specified by:

readExternal in interface java.io.Externalizable

Throws:

java.io.IOException

java.lang.ClassNotFoundException