com.esri.arcgis.geodatabase
Class GPMessageManager

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

All Implemented Interfaces:

IGPMessageManager, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class GPMessageManager
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IGPMessageManager

Esri GPMessageManager object.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

GPMessageManager()
Constructs a GPMessageManager using ArcGIS Engine.

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

Method Summary

void	addMessage(int type, int iD, IGPMessages msgs) Add a given message from the message id to the messages object.
void	addMessage1Args(int type, int iD, String arg1, IGPMessages msgs) Add a given message from the message id to the messages object.
void	addMessage2Args(int type, int iD, String arg1, String arg2, IGPMessages msgs) Add a given message from the message id to the messages object.
void	addMessageText(int type, int iD, String msg, IGPMessages msgs) Add a given message from the message text to the messages object.
void	chainMessage(int type, int iD) Chain a given message from the message id.
void	chainMessage1Args(int type, int iD, String arg1) Chain a given message from the message id.
void	chainMessage2Args(int type, int iD, String arg1, String arg2) Chain a given message from the message id.
void	chainMessageText(int type, int iD, String msg) Chain a given message from the message text.
void	checkForErrors(long fdoError, IGPMessages messages, boolean keepAllErrors) Check for any errors in the IErrorInfo structure.
boolean	equals(Object o) Compare this object with another
String	generateMessage(int type, int iD) Generate a given message from the message id.
static String	getClsid() getClsid.
String	getMessage(int iD) Get a given message.
int	hashCode() the hashcode for this object
void	lookForGPChainedErrors(IGPMessages messages) Transfer any GP errors or warnings to the messages object.
void	setMessage(int type, int iD, int pos, IGPMessages msgs) Set a given message from the message id to the messages object.
void	setMessage1Args(int type, int iD, String arg1, int pos, IGPMessages msgs) Set a given message from the message id to the messages object.
void	setMessage2Args(int type, int iD, String arg1, String arg2, int pos, IGPMessages msgs) Set a given message from the message id to the messages object.
void	setMessageText(int type, int iD, String msg, int pos, IGPMessages msgs) Set a given message from the message text to the messages object.

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

GPMessageManager

public GPMessageManager()
                 throws IOException,
                        UnknownHostException

Constructs a GPMessageManager using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

GPMessageManager

public GPMessageManager(Object obj)
                 throws IOException

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

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

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

getMessage

public String getMessage(int iD)
                  throws IOException,
                         AutomationException

Get a given message.

Product Availability

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

Specified by:

getMessage in interface IGPMessageManager

Parameters:

iD - The iD (in)

Returns:

The msg

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

generateMessage

public String generateMessage(int type,
                              int iD)
                       throws IOException,
                              AutomationException

Generate a given message from the message id.

Product Availability

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

Specified by:

generateMessage in interface IGPMessageManager

Parameters:

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

iD - The iD (in)

Returns:

The msg

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addMessage

public void addMessage(int type,
                       int iD,
                       IGPMessages msgs)
                throws IOException,
                       AutomationException

Add a given message from the message id to the messages object.

Product Availability

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

Specified by:

addMessage in interface IGPMessageManager

Parameters:

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

iD - The iD (in)

msgs - A reference to a com.esri.arcgis.geodatabase.IGPMessages (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addMessage1Args

public void addMessage1Args(int type,
                            int iD,
                            String arg1,
                            IGPMessages msgs)
                     throws IOException,
                            AutomationException

Add a given message from the message id to the messages object.

Product Availability

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

Specified by:

addMessage1Args in interface IGPMessageManager

Parameters:

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

iD - The iD (in)

arg1 - The arg1 (in)

msgs - A reference to a com.esri.arcgis.geodatabase.IGPMessages (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addMessage2Args

public void addMessage2Args(int type,
                            int iD,
                            String arg1,
                            String arg2,
                            IGPMessages msgs)
                     throws IOException,
                            AutomationException

Add a given message from the message id to the messages object.

Product Availability

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

Specified by:

addMessage2Args in interface IGPMessageManager

Parameters:

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

iD - The iD (in)

arg1 - The arg1 (in)

arg2 - The arg2 (in)

msgs - A reference to a com.esri.arcgis.geodatabase.IGPMessages (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addMessageText

public void addMessageText(int type,
                           int iD,
                           String msg,
                           IGPMessages msgs)
                    throws IOException,
                           AutomationException

Add a given message from the message text to the messages object.

Product Availability

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

Specified by:

addMessageText in interface IGPMessageManager

Parameters:

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

iD - The iD (in)

msg - The msg (in)

msgs - A reference to a com.esri.arcgis.geodatabase.IGPMessages (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMessage

public void setMessage(int type,
                       int iD,
                       int pos,
                       IGPMessages msgs)
                throws IOException,
                       AutomationException

Set a given message from the message id to the messages object.

Product Availability

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

Specified by:

setMessage in interface IGPMessageManager

Parameters:

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

iD - The iD (in)

pos - The pos (in)

msgs - A reference to a com.esri.arcgis.geodatabase.IGPMessages (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMessage1Args

public void setMessage1Args(int type,
                            int iD,
                            String arg1,
                            int pos,
                            IGPMessages msgs)
                     throws IOException,
                            AutomationException

Set a given message from the message id to the messages object.

Product Availability

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

Specified by:

setMessage1Args in interface IGPMessageManager

Parameters:

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

iD - The iD (in)

arg1 - The arg1 (in)

pos - The pos (in)

msgs - A reference to a com.esri.arcgis.geodatabase.IGPMessages (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMessage2Args

public void setMessage2Args(int type,
                            int iD,
                            String arg1,
                            String arg2,
                            int pos,
                            IGPMessages msgs)
                     throws IOException,
                            AutomationException

Set a given message from the message id to the messages object.

Product Availability

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

Specified by:

setMessage2Args in interface IGPMessageManager

Parameters:

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

iD - The iD (in)

arg1 - The arg1 (in)

arg2 - The arg2 (in)

pos - The pos (in)

msgs - A reference to a com.esri.arcgis.geodatabase.IGPMessages (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMessageText

public void setMessageText(int type,
                           int iD,
                           String msg,
                           int pos,
                           IGPMessages msgs)
                    throws IOException,
                           AutomationException

Set a given message from the message text to the messages object.

Product Availability

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

Specified by:

setMessageText in interface IGPMessageManager

Parameters:

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

iD - The iD (in)

msg - The msg (in)

pos - The pos (in)

msgs - A reference to a com.esri.arcgis.geodatabase.IGPMessages (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

chainMessage

public void chainMessage(int type,
                         int iD)
                  throws IOException,
                         AutomationException

Chain a given message from the message id.

Product Availability

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

Specified by:

chainMessage in interface IGPMessageManager

Parameters:

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

iD - The iD (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

chainMessage1Args

public void chainMessage1Args(int type,
                              int iD,
                              String arg1)
                       throws IOException,
                              AutomationException

Chain a given message from the message id.

Product Availability

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

Specified by:

chainMessage1Args in interface IGPMessageManager

Parameters:

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

iD - The iD (in)

arg1 - The arg1 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

chainMessage2Args

public void chainMessage2Args(int type,
                              int iD,
                              String arg1,
                              String arg2)
                       throws IOException,
                              AutomationException

Chain a given message from the message id.

Product Availability

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

Specified by:

chainMessage2Args in interface IGPMessageManager

Parameters:

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

iD - The iD (in)

arg1 - The arg1 (in)

arg2 - The arg2 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

chainMessageText

public void chainMessageText(int type,
                             int iD,
                             String msg)
                      throws IOException,
                             AutomationException

Chain a given message from the message text.

Product Availability

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

Specified by:

chainMessageText in interface IGPMessageManager

Parameters:

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

iD - The iD (in)

msg - The msg (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

checkForErrors

public void checkForErrors(long fdoError,
                           IGPMessages messages,
                           boolean keepAllErrors)
                    throws IOException,
                           AutomationException

Check for any errors in the IErrorInfo structure.

Product Availability

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

Specified by:

checkForErrors in interface IGPMessageManager

Parameters:

fdoError - An error code (in)

messages - A reference to a com.esri.arcgis.geodatabase.IGPMessages (in)

keepAllErrors - The keepAllErrors (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

lookForGPChainedErrors

public void lookForGPChainedErrors(IGPMessages messages)
                            throws IOException,
                                   AutomationException

Transfer any GP errors or warnings to the messages object.

Product Availability

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

Specified by:

lookForGPChainedErrors in interface IGPMessageManager

Parameters:

messages - A reference to a com.esri.arcgis.geodatabase.IGPMessages (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.