com.esri.arcgis.trackinganalyst
Class StatusMessage

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

All Implemented Interfaces:

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

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

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

Description 'Message reporting status to 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.IStatusMessage

IID, IIDcc018a05_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

StatusMessage()
Constructs a StatusMessage using ArcGIS Engine.

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

Method Summary

java.lang.Object	convertToSupportedObject(int docVersion) Convert the object to another object that is supported.
boolean	equals(java.lang.Object o) Compare this object with another
void	getClassID(GUID[] pClassID) getClassID
static java.lang.String	getClsid() getClsid.
java.lang.Object	getCreationDate() Indicates the date of the status message's creation.
java.lang.String	getDestination() Indicates destination of status message.
int	getErrorCode() Identifies error code values for the status message.
java.lang.String	getID() ID value for the status message.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
int	getMessageType() Indicates type of status message.
java.lang.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	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 StatusMessage.
void	save(IStream pstm, int fClearDirty) save
void	setDestination(java.lang.String pVal) Indicates destination of status message.
void	setErrorCode(int pVal) Identifies error code values for the status message.
void	setOrigin(java.lang.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(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

StatusMessage

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

Constructs a StatusMessage using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

StatusMessage

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

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

Specified by:

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

getCreationDate

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

Indicates the date of the status message's creation.

Specified by:

getCreationDate in interface IMessage

Specified by:

getCreationDate in interface IStatusMessage

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 status message.

Specified by:

getID in interface IMessage

Specified by:

getID in interface IStatusMessage

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 status message.

Specified by:

getMessageType in interface IMessage

Specified by:

getMessageType in interface IStatusMessage

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 status message.

Specified by:

getPriority in interface IMessage

Specified by:

getPriority in interface IStatusMessage

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 status message.

Specified by:

setPriority in interface IMessage

Specified by:

setPriority in interface IStatusMessage

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 status message.

Specified by:

getDestination in interface IMessage

Specified by:

getDestination in interface IStatusMessage

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 status message.

Specified by:

setDestination in interface IMessage

Specified by:

setDestination in interface IStatusMessage

Parameters:

pVal - The pVal (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getErrorCode

public int getErrorCode()
                 throws java.io.IOException,
                        AutomationException

Identifies error code values for the status message.

Specified by:

getErrorCode in interface IStatusMessage

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setErrorCode

public void setErrorCode(int pVal)
                  throws java.io.IOException,
                         AutomationException

Identifies error code values for the status message.

Specified by:

setErrorCode in interface IStatusMessage

Parameters:

pVal - The pVal (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getStatus

public int getStatus()
              throws java.io.IOException,
                     AutomationException

Identifies status value of the message.

Specified by:

getStatus in interface IStatusMessage

Returns:

A com.esri.arcgis.trackinganalyst.enumResponseStatus constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setStatus

public void setStatus(int pVal)
               throws java.io.IOException,
                      AutomationException

Identifies status value of the message.

Specified by:

setStatus in interface IStatusMessage

Parameters:

pVal - A com.esri.arcgis.trackinganalyst.enumResponseStatus constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getOrigin

public java.lang.String getOrigin()
                           throws java.io.IOException,
                                  AutomationException

Identifies origin value for status message.

Specified by:

getOrigin in interface IStatusMessage

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setOrigin

public void setOrigin(java.lang.String pVal)
               throws java.io.IOException,
                      AutomationException

Identifies origin value for status message.

Specified by:

setOrigin in interface IStatusMessage

Parameters:

pVal - The pVal (in)

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