com.esri.arcgis.geodatabase
Class GPMessage

java.lang.Object
  com.esri.arcgis.geodatabase.GPMessage

All Implemented Interfaces:

IGPMessage, IGPMessage2, com.esri.arcgis.interop.RemoteObjRef, IClone, IPersist, IPersistStream, IXMLSerialize, Externalizable, Serializable

public class GPMessage
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IGPMessage, IGPMessage2, IClone, IPersistStream, IXMLSerialize, Externalizable

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:

Serialized Form

Constructor Summary

GPMessage()
Constructs a GPMessage using ArcGIS Engine.

GPMessage(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
GPMessage theGPMessage = (GPMessage) obj;

Method Summary

void	assign(IClone src) Assigns the properties of src to the receiver.
void	createIDMessage(int type, int errorCode) Creates the error or warning message with code ID.
void	createIDMessage1Args(int type, int errorCode, String arg) Creates the error or warning message with code ID, one argument.
void	createIDMessage2Args(int type, int errorCode, String arg1, String arg2) Creates the error or warning message with code ID, two arguments.
void	deserialize(IXMLSerializeData data) Deserializes an object from XML.
boolean	equals(Object o) Compare this object with another
IClone	esri_clone() Clones the receiver and assigns the result to *clone.
void	getClassID(GUID[] pClassID) getClassID
static String	getClsid() getClsid.
String	getDescription() The description of the geoprocessing message.
int	getErrorCode() The error code for the geoprocessing message.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
int	getType() The geoprocessing message type.
int	hashCode() the hashcode for this object
boolean	isAbort() Indicates if the message is an abort.
void	isDirty() isDirty
boolean	isEqual(IClone other) Indicates if the receiver and other have the same properties.
boolean	isError() Indicates if the message is an error.
boolean	isIdentical(IClone other) Indicates if the receiver and other are the same object.
boolean	isInformational() Indicates if the message is informative.
boolean	isWarning() Indicates if the message is a warning.
void	load(IStream pstm) load
void	readExternal(ObjectInput in)
void	save(IStream pstm, int fClearDirty) save
void	serialize(IXMLSerializeData data) Serializes an object to XML.
void	setDescription(String message) The description of the geoprocessing message.
void	setErrorCode(int errorCode) The error code for the geoprocessing message.
void	setType(int type) The geoprocessing message type.
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

GPMessage

public GPMessage()
          throws IOException,
                 UnknownHostException

Constructs a GPMessage using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

GPMessage

public GPMessage(Object obj)
          throws IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
GPMessage theGPMessage = (GPMessage) obj;

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

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

setType

public void setType(int type)
             throws IOException,
                    AutomationException

The geoprocessing message type.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setType in interface IGPMessage

Parameters:

type - A com.esri.arcgis.geodatabase.esriGPMessageType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getType

public int getType()
            throws IOException,
                   AutomationException

The geoprocessing message type.

Remarks

The get_Type property returns the message's type. Valid values are defined in the esriGPMessageType enumeration; they are: esriGPMessageTypeInformative, esriGPMessageTypeProcessDefinition, esriGPMessageTypeProcessStart, esriGPMessageTypeProcessStop, esriGPMessageTypeWarning, esriGPMessageTypeAbort, esriGPMessageTypeError, and esriGPMessageTypeEmpty.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getType in interface IGPMessage

Returns:

A com.esri.arcgis.geodatabase.esriGPMessageType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setErrorCode

public void setErrorCode(int errorCode)
                  throws IOException,
                         AutomationException

The error code for the geoprocessing message.

Remarks

The ErrorCode property returns the error code for a given message. It applies only to messages of type error.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setErrorCode in interface IGPMessage

Parameters:

errorCode - The errorCode (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getErrorCode

public int getErrorCode()
                 throws IOException,
                        AutomationException

The error code for the geoprocessing message.

Remarks

The get_ErrorCode property returns the message's error code. It applies only to a message of type esriGPMessageTypeError.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getErrorCode in interface IGPMessage

Returns:

The errorCode

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDescription

public void setDescription(String message)
                    throws IOException,
                           AutomationException

The description of the geoprocessing message.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setDescription in interface IGPMessage

Parameters:

message - The message (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDescription

public String getDescription()
                      throws IOException,
                             AutomationException

The description of the geoprocessing message.

Remarks

The get_Description property returns the actual message text string.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getDescription in interface IGPMessage

Returns:

The message

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isInformational

public boolean isInformational()
                        throws IOException,
                               AutomationException

Indicates if the message is informative.

Remarks

The IsInformational method returns true if the message is of type esriGPMessageTypeInformative, esriGPMessageTypeProcessDefinition, esriGPMessageTypeProcessStart, and esriGPMessageTypeProcessStop.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isInformational in interface IGPMessage

Returns:

The isInformational

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isWarning

public boolean isWarning()
                  throws IOException,
                         AutomationException

Indicates if the message is a warning.

Remarks

The IsWarning method returns true if the message is of type esriGPMessageTypeWarning.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isWarning in interface IGPMessage

Returns:

The isWarning

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isError

public boolean isError()
                throws IOException,
                       AutomationException

Indicates if the message is an error.

Remarks

The IsError method returns true if the message is of type esriGPMessageTypeError.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isError in interface IGPMessage

Returns:

The isError

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isAbort

public boolean isAbort()
                throws IOException,
                       AutomationException

Indicates if the message is an abort.

Remarks

The IsAbort method returns true if the message is of type esriGPMessageTypeAbort.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isAbort in interface IGPMessage

Returns:

The isAbort

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createIDMessage

public void createIDMessage(int type,
                            int errorCode)
                     throws IOException,
                            AutomationException

Creates the error or warning message with code ID.

Product Availability

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

Specified by:

createIDMessage in interface IGPMessage2

Parameters:

type - A com.esri.arcgis.geodatabase.esriGPMessageType constant (in)

errorCode - The errorCode (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createIDMessage1Args

public void createIDMessage1Args(int type,
                                 int errorCode,
                                 String arg)
                          throws IOException,
                                 AutomationException

Creates the error or warning message with code ID, one argument.

Product Availability

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

Specified by:

createIDMessage1Args in interface IGPMessage2

Parameters:

type - A com.esri.arcgis.geodatabase.esriGPMessageType constant (in)

errorCode - The errorCode (in)

arg - The arg (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createIDMessage2Args

public void createIDMessage2Args(int type,
                                 int errorCode,
                                 String arg1,
                                 String arg2)
                          throws IOException,
                                 AutomationException

Creates the error or warning message with code ID, two arguments.

Product Availability

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

Specified by:

createIDMessage2Args in interface IGPMessage2

Parameters:

type - A com.esri.arcgis.geodatabase.esriGPMessageType constant (in)

errorCode - The errorCode (in)

arg1 - The arg1 (in)

arg2 - The arg2 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

esri_clone

public IClone esri_clone()
                  throws IOException,
                         AutomationException

Clones the receiver and assigns the result to *clone.

Product Availability

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

Specified by:

esri_clone in interface IClone

Returns:

A reference to a com.esri.arcgis.system.IClone

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

assign

public void assign(IClone src)
            throws IOException,
                   AutomationException

Assigns the properties of src to the receiver.

Description

Use Assign method to assign the properties of source object to receiver object. Both objects need to have the same CLSIDs. Both source and receiver objects need to be instantiated.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

assign in interface IClone

Parameters:

src - A reference to a com.esri.arcgis.system.IClone (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isEqual

public boolean isEqual(IClone other)
                throws IOException,
                       AutomationException

Indicates if the receiver and other have the same properties.

Description

IsEqual returns True if the receiver and the source have the same properties. Note, this does not imply that the receiver and the source reference the same object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isEqual in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The equal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isIdentical

public boolean isIdentical(IClone other)
                    throws IOException,
                           AutomationException

Indicates if the receiver and other are the same object.

Description

IsIdentical returns true if the receiver and the source reference the same object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isIdentical in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The identical

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.

serialize

public void serialize(IXMLSerializeData data)
               throws IOException,
                      AutomationException

Serializes an object to XML.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

serialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deserialize

public void deserialize(IXMLSerializeData data)
                 throws IOException,
                        AutomationException

Deserializes an object from XML.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

deserialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)

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