com.esri.arcgis.geodatabase
Interface IGPMessageManager

All Superinterfaces:

Serializable

All Known Implementing Classes:

GPMessageManager, GPUtilities

public interface IGPMessageManager
extends Serializable

Provides access to the properties/methods of a geoprocessing message manager object.

Description

This interface is new at ArcGIS 9.3.

Product Availability

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

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.
String	generateMessage(int type, int iD) Generate a given message from the message id.
String	getMessage(int iD) Get a given message.
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.

Method Detail

getMessage

String getMessage(int iD)
                  throws IOException,
                         AutomationException

Get a given message.

Product Availability

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

Parameters:

iD - The iD (in)

Returns:

The msg

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

generateMessage

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.

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

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.

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

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.

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

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.

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

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.

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

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.

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

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.

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

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.

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

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.

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

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.

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

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.

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

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.

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

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.

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

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.

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

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.

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.