com.esri.arcgis.geodatabase
Class GPMessages

java.lang.Object
  extended by com.esri.arcgis.geodatabase.GPMessages
All Implemented Interfaces:
IGPMessage, IGPMessages, com.esri.arcgis.interop.RemoteObjRef, IClone, IPersist, IPersistStream, IXMLSerialize, java.io.Externalizable, java.io.Serializable

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

COM Class 'GPMessages'. 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.IGPMessages
IID, IID0696aa9d_c26b_4a3e_89b7_3763ea11f16c, 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
GPMessages()
          Constructs a GPMessages using ArcGIS Engine.
GPMessages(java.lang.Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
GPMessages theGPMessages = (GPMessages) obj;
 
Method Summary
 void add(IGPMessage msg)
          Adds a message object to the messages.
 void addAbort(java.lang.String message)
          Adds an abort message to the messages.
 void addError(int errorCode, java.lang.String message)
          Adds an error message to the messages.
 void addMessage(java.lang.String message)
          Adds an informative message to the messages.
 void addMessages(IGPMessages messages)
          Adds all messages from an existing messages object to this messages object.
 void addWarning(java.lang.String message)
          Adds a warning message to the messages.
 void assign(IClone src)
          Assigns the properties of src to the receiver.
 void clear()
          Clears the message objects from messages object.
 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.
 IGPMessagesCallback getCallback()
          The callback object associated with the GPMessages object.
 void getClassID(GUID[] pClassID)
          getClassID
static java.lang.String getClsid()
          getClsid.
 int getCount()
          The message count.
 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.
 int getMaxSeverity()
          The maximum message severity.
 IGPMessage getMessage(int index)
          Provides a message object from the specified location.
 IArray getMessages()
          The array of message objects.
 void getSizeMax(_ULARGE_INTEGER[] pcbSize)
          getSizeMax
 int getType()
          The geoprocessing message type.
 int hashCode()
          the hashcode for this object
 void initializeMessages(int nMessages)
          Creates a number of empty messages and adds them to this messages 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 GPMessages.
 void replace(int index, IGPMessage msg)
          Replace an existing message in a specified location with a new message object.
 void replaceAbort(int index, java.lang.String message)
          Creates message of type esriGPMessageTypeAbort and replaces it into a specified position.
 void replaceError(int index, int errorCode, java.lang.String message)
          Creates message of type esriGPMessageTypeError and replaces it into a specified position.
 void replaceMessage(int index, java.lang.String message)
          Creates message and replaces it into a specified position.
 void replaceWarning(int index, java.lang.String message)
          Creates message of type esriGPMessageTypeWarning and replaces it into a specified position.
 void save(IStream pstm, int fClearDirty)
          save
 void serialize(IXMLSerializeData data)
          Serializes an object to XML.
 void setCallbackByRef(IGPMessagesCallback messagesCallback)
          The callback object associated with the GPMessages object.
 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

GPMessages

public GPMessages()
           throws java.io.IOException,
                  java.net.UnknownHostException
Constructs a GPMessages using ArcGIS Engine.

Throws:
java.io.IOException - if there are interop problems
java.net.UnknownHostException - if there are interop problems

GPMessages

public GPMessages(java.lang.Object obj)
           throws java.io.IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
GPMessages theGPMessages = (GPMessages) obj;

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

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

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.

setCallbackByRef

public void setCallbackByRef(IGPMessagesCallback messagesCallback)
                      throws java.io.IOException,
                             AutomationException
The callback object associated with the GPMessages object.

Specified by:
setCallbackByRef in interface IGPMessages
Parameters:
messagesCallback - A reference to a com.esri.arcgis.geodatabase.IGPMessagesCallback (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCallback

public IGPMessagesCallback getCallback()
                                throws java.io.IOException,
                                       AutomationException
The callback object associated with the GPMessages object.

Specified by:
getCallback in interface IGPMessages
Returns:
A reference to a com.esri.arcgis.geodatabase.IGPMessagesCallback
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

clear

public void clear()
           throws java.io.IOException,
                  AutomationException
Clears the message objects from messages object.

Specified by:
clear in interface IGPMessages
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

add

public void add(IGPMessage msg)
         throws java.io.IOException,
                AutomationException
Adds a message object to the messages.

Specified by:
add in interface IGPMessages
Parameters:
msg - A reference to a com.esri.arcgis.geodatabase.IGPMessage (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addWarning

public void addWarning(java.lang.String message)
                throws java.io.IOException,
                       AutomationException
Adds a warning message to the messages.

Specified by:
addWarning in interface IGPMessages
Parameters:
message - The message (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addAbort

public void addAbort(java.lang.String message)
              throws java.io.IOException,
                     AutomationException
Adds an abort message to the messages.

Specified by:
addAbort in interface IGPMessages
Parameters:
message - The message (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addError

public void addError(int errorCode,
                     java.lang.String message)
              throws java.io.IOException,
                     AutomationException
Adds an error message to the messages.

Specified by:
addError in interface IGPMessages
Parameters:
errorCode - The errorCode (in)
message - The message (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addMessage

public void addMessage(java.lang.String message)
                throws java.io.IOException,
                       AutomationException
Adds an informative message to the messages.

Specified by:
addMessage in interface IGPMessages
Parameters:
message - The message (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addMessages

public void addMessages(IGPMessages messages)
                 throws java.io.IOException,
                        AutomationException
Adds all messages from an existing messages object to this messages object.

Specified by:
addMessages in interface IGPMessages
Parameters:
messages - A reference to a com.esri.arcgis.geodatabase.IGPMessages (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

initializeMessages

public void initializeMessages(int nMessages)
                        throws java.io.IOException,
                               AutomationException
Creates a number of empty messages and adds them to this messages object.

Specified by:
initializeMessages in interface IGPMessages
Parameters:
nMessages - The nMessages (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

replace

public void replace(int index,
                    IGPMessage msg)
             throws java.io.IOException,
                    AutomationException
Replace an existing message in a specified location with a new message object.

Specified by:
replace in interface IGPMessages
Parameters:
index - The index (in)
msg - A reference to a com.esri.arcgis.geodatabase.IGPMessage (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

replaceError

public void replaceError(int index,
                         int errorCode,
                         java.lang.String message)
                  throws java.io.IOException,
                         AutomationException
Creates message of type esriGPMessageTypeError and replaces it into a specified position.

Specified by:
replaceError in interface IGPMessages
Parameters:
index - The index (in)
errorCode - The errorCode (in)
message - The message (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

replaceWarning

public void replaceWarning(int index,
                           java.lang.String message)
                    throws java.io.IOException,
                           AutomationException
Creates message of type esriGPMessageTypeWarning and replaces it into a specified position.

Specified by:
replaceWarning in interface IGPMessages
Parameters:
index - The index (in)
message - The message (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

replaceAbort

public void replaceAbort(int index,
                         java.lang.String message)
                  throws java.io.IOException,
                         AutomationException
Creates message of type esriGPMessageTypeAbort and replaces it into a specified position.

Specified by:
replaceAbort in interface IGPMessages
Parameters:
index - The index (in)
message - The message (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

replaceMessage

public void replaceMessage(int index,
                           java.lang.String message)
                    throws java.io.IOException,
                           AutomationException
Creates message and replaces it into a specified position.

Specified by:
replaceMessage in interface IGPMessages
Parameters:
index - The index (in)
message - The message (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCount

public int getCount()
             throws java.io.IOException,
                    AutomationException
The message count.

Specified by:
getCount in interface IGPMessages
Returns:
The count
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMessage

public IGPMessage getMessage(int index)
                      throws java.io.IOException,
                             AutomationException
Provides a message object from the specified location.

Specified by:
getMessage in interface IGPMessages
Parameters:
index - The index (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IGPMessage
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMessages

public IArray getMessages()
                   throws java.io.IOException,
                          AutomationException
The array of message objects.

Specified by:
getMessages in interface IGPMessages
Returns:
A reference to a com.esri.arcgis.system.IArray
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMaxSeverity

public int getMaxSeverity()
                   throws java.io.IOException,
                          AutomationException
The maximum message severity.

Specified by:
getMaxSeverity in interface IGPMessages
Returns:
A com.esri.arcgis.geodatabase.esriGPMessageSeverity constant
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