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, java.io.Externalizable, java.io.Serializable

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

COM Class 'GPMessage'. Generated 3/19/2015 1:20:43 PM from 'C:\ArcGIS\COM\esriGeoDatabase.olb'

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.geodatabase.IGPMessage

IID, IID93d8accb_3a6e_4fa2_b283_197ee5d0e334, xxDummy

Fields inherited from interface com.esri.arcgis.geodatabase.IGPMessage2

IID, IIDed4b67f0_b72b_42f7_b033_bd62c8ed163f, xxDummy

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

IID, IID9bff8aeb_e415_11d0_943c_080009eebecb, 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.IXMLSerialize

IID, IIDc8545045_6615_48e3_af27_52a0e5fc35e2, xxDummy

Constructor Summary

GPMessage()
Constructs a GPMessage using ArcGIS Engine.

GPMessage(java.lang.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, java.lang.String arg) Creates the error or warning message with code ID, one argument.
void	createIDMessage2Args(int type, int errorCode, java.lang.String arg1, java.lang.String arg2) Creates the error or warning message with code ID, two arguments.
void	deserialize(IXMLSerializeData data) Deserializes an object from XML.
boolean	equals(java.lang.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 java.lang.String	getClsid() getClsid.
java.lang.String	getDescription() The description of the geoprocessing message.
int	getErrorCode() The error code for the geoprocessing message.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
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(java.io.ObjectInput in)
void	release() Release a GPMessage.
void	save(IStream pstm, int fClearDirty) save
void	serialize(IXMLSerializeData data) Serializes an object to XML.
void	setDescription(java.lang.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(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

GPMessage

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

Constructs a GPMessage using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

GPMessage

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

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

Specified by:

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

setType

public void setType(int type)
             throws java.io.IOException,
                    AutomationException

The geoprocessing message type.

Specified by:

setType in interface IGPMessage

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getType

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

The geoprocessing message type.

Specified by:

getType in interface IGPMessage

Returns:

A com.esri.arcgis.geodatabase.esriGPMessageType constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setErrorCode

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

The error code for the geoprocessing message.

Specified by:

setErrorCode in interface IGPMessage

Parameters:

errorCode - The errorCode (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

The error code for the geoprocessing message.

Specified by:

getErrorCode in interface IGPMessage

Returns:

The errorCode

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDescription

public void setDescription(java.lang.String message)
                    throws java.io.IOException,
                           AutomationException

The description of the geoprocessing message.

Specified by:

setDescription in interface IGPMessage

Parameters:

message - The message (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDescription

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

The description of the geoprocessing message.

Specified by:

getDescription in interface IGPMessage

Returns:

The message

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isInformational

public boolean isInformational()
                        throws java.io.IOException,
                               AutomationException

Indicates if the message is informative.

Specified by:

isInformational in interface IGPMessage

Returns:

The isInformational

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isWarning

public boolean isWarning()
                  throws java.io.IOException,
                         AutomationException

Indicates if the message is a warning.

Specified by:

isWarning in interface IGPMessage

Returns:

The isWarning

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isError

public boolean isError()
                throws java.io.IOException,
                       AutomationException

Indicates if the message is an error.

Specified by:

isError in interface IGPMessage

Returns:

The isError

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isAbort

public boolean isAbort()
                throws java.io.IOException,
                       AutomationException

Indicates if the message is an abort.

Specified by:

isAbort in interface IGPMessage

Returns:

The isAbort

Throws:

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

AutomationException - If the ArcObject component throws an exception.

createIDMessage

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

Creates the error or warning message with code ID.

Specified by:

createIDMessage in interface IGPMessage2

Parameters:

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

errorCode - The errorCode (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

createIDMessage1Args

public void createIDMessage1Args(int type,
                                 int errorCode,
                                 java.lang.String arg)
                          throws java.io.IOException,
                                 AutomationException

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

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:

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

AutomationException - If the ArcObject component throws an exception.

createIDMessage2Args

public void createIDMessage2Args(int type,
                                 int errorCode,
                                 java.lang.String arg1,
                                 java.lang.String arg2)
                          throws java.io.IOException,
                                 AutomationException

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

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:

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

AutomationException - If the ArcObject component throws an exception.

esri_clone

public IClone esri_clone()
                  throws java.io.IOException,
                         AutomationException

Clones the receiver and assigns the result to *clone.

Specified by:

esri_clone in interface IClone

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

assign

public void assign(IClone src)
            throws java.io.IOException,
                   AutomationException

Assigns the properties of src to the receiver.

Specified by:

assign in interface IClone

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isEqual

public boolean isEqual(IClone other)
                throws java.io.IOException,
                       AutomationException

Indicates if the receiver and other have the same properties.

Specified by:

isEqual in interface IClone

Parameters:

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

Returns:

The equal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isIdentical

public boolean isIdentical(IClone other)
                    throws java.io.IOException,
                           AutomationException

Indicates if the receiver and other are the same object.

Specified by:

isIdentical in interface IClone

Parameters:

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

Returns:

The identical

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.

serialize

public void serialize(IXMLSerializeData data)
               throws java.io.IOException,
                      AutomationException

Serializes an object to XML.

Specified by:

serialize in interface IXMLSerialize

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

deserialize

public void deserialize(IXMLSerializeData data)
                 throws java.io.IOException,
                        AutomationException

Deserializes an object from XML.

Specified by:

deserialize in interface IXMLSerialize

Parameters:

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

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