com.esri.arcgis.geodatabase
Interface IGPMessageManager

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

GPMessageManager, GPUtilities, IGPMessageManagerProxy

public interface IGPMessageManager
extends java.io.Serializable

COM Interface 'IGPMessageManager'. Generated 3/19/2015 1:20:57 PM from 'C:\ArcGIS\COM\esriGeoDatabase.olb'

Description: 'Provides access to the properties/methods of a geoprocessing message manager object.' 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 =

Field Summary

static java.lang.String	IID Deprecated. Internal use only
static int	IIDa440ec5f_34b5_45b3_bcd1_ae631cf84214
static int	xxDummy Deprecated. Internal use only

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, java.lang.String arg1, IGPMessages msgs) Add a given message from the message id to the messages object.
void	addMessage2Args(int type, int iD, java.lang.String arg1, java.lang.String arg2, IGPMessages msgs) Add a given message from the message id to the messages object.
void	addMessageText(int type, int iD, java.lang.String msg, IGPMessages msgs) Add a given message from the message text to the messages object.
void	chainGPMessage(IGPMessage pMsg) Chain a given GPMessage.
void	chainMessage(int type, int iD) Chain a given message from the message id.
void	chainMessage1Args(int type, int iD, java.lang.String arg1) Chain a given message from the message id.
void	chainMessage2Args(int type, int iD, java.lang.String arg1, java.lang.String arg2) Chain a given message from the message id.
void	chainMessageText(int type, int iD, java.lang.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.
java.lang.String	generateMessage(int type, int iD) Generate a given message from the message id.
java.lang.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, java.lang.String arg1, int pos, IGPMessages msgs) Set a given message from the message id to the messages object.
void	setMessage2Args(int type, int iD, java.lang.String arg1, java.lang.String arg2, int pos, IGPMessages msgs) Set a given message from the message id to the messages object.
void	setMessageText(int type, int iD, java.lang.String msg, int pos, IGPMessages msgs) Set a given message from the message text to the messages object.

Field Detail

IIDa440ec5f_34b5_45b3_bcd1_ae631cf84214

static final int IIDa440ec5f_34b5_45b3_bcd1_ae631cf84214

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

getMessage

java.lang.String getMessage(int iD)
                            throws java.io.IOException,
                                   AutomationException

Get a given message.

Parameters:

iD - The iD (in)

Returns:

The msg

Throws:

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

AutomationException - If the ArcObject component throws an exception.

generateMessage

java.lang.String generateMessage(int type,
                                 int iD)
                                 throws java.io.IOException,
                                        AutomationException

Generate a given message from the message id.

Parameters:

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

iD - The iD (in)

Returns:

The msg

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addMessage

void addMessage(int type,
                int iD,
                IGPMessages msgs)
                throws java.io.IOException,
                       AutomationException

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

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:

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

AutomationException - If the ArcObject component throws an exception.

addMessage1Args

void addMessage1Args(int type,
                     int iD,
                     java.lang.String arg1,
                     IGPMessages msgs)
                     throws java.io.IOException,
                            AutomationException

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

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:

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

AutomationException - If the ArcObject component throws an exception.

addMessage2Args

void addMessage2Args(int type,
                     int iD,
                     java.lang.String arg1,
                     java.lang.String arg2,
                     IGPMessages msgs)
                     throws java.io.IOException,
                            AutomationException

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

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:

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

AutomationException - If the ArcObject component throws an exception.

addMessageText

void addMessageText(int type,
                    int iD,
                    java.lang.String msg,
                    IGPMessages msgs)
                    throws java.io.IOException,
                           AutomationException

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

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:

java.io.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 java.io.IOException,
                       AutomationException

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

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:

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

AutomationException - If the ArcObject component throws an exception.

setMessage1Args

void setMessage1Args(int type,
                     int iD,
                     java.lang.String arg1,
                     int pos,
                     IGPMessages msgs)
                     throws java.io.IOException,
                            AutomationException

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

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:

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

AutomationException - If the ArcObject component throws an exception.

setMessage2Args

void setMessage2Args(int type,
                     int iD,
                     java.lang.String arg1,
                     java.lang.String arg2,
                     int pos,
                     IGPMessages msgs)
                     throws java.io.IOException,
                            AutomationException

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

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:

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

AutomationException - If the ArcObject component throws an exception.

setMessageText

void setMessageText(int type,
                    int iD,
                    java.lang.String msg,
                    int pos,
                    IGPMessages msgs)
                    throws java.io.IOException,
                           AutomationException

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

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:

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

AutomationException - If the ArcObject component throws an exception.

chainMessage

void chainMessage(int type,
                  int iD)
                  throws java.io.IOException,
                         AutomationException

Chain a given message from the message id.

Parameters:

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

iD - The iD (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

chainMessage1Args

void chainMessage1Args(int type,
                       int iD,
                       java.lang.String arg1)
                       throws java.io.IOException,
                              AutomationException

Chain a given message from the message id.

Parameters:

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

iD - The iD (in)

arg1 - The arg1 (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

chainMessage2Args

void chainMessage2Args(int type,
                       int iD,
                       java.lang.String arg1,
                       java.lang.String arg2)
                       throws java.io.IOException,
                              AutomationException

Chain a given message from the message id.

Parameters:

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

iD - The iD (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.

chainMessageText

void chainMessageText(int type,
                      int iD,
                      java.lang.String msg)
                      throws java.io.IOException,
                             AutomationException

Chain a given message from the message text.

Parameters:

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

iD - The iD (in)

msg - The msg (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

checkForErrors

void checkForErrors(long fdoError,
                    IGPMessages messages,
                    boolean keepAllErrors)
                    throws java.io.IOException,
                           AutomationException

Check for any errors in the IErrorInfo structure.

Parameters:

fdoError - An error code (in)

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

keepAllErrors - The keepAllErrors (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

lookForGPChainedErrors

void lookForGPChainedErrors(IGPMessages messages)
                            throws java.io.IOException,
                                   AutomationException

Transfer any GP errors or warnings to the messages object.

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.

chainGPMessage

void chainGPMessage(IGPMessage pMsg)
                    throws java.io.IOException,
                           AutomationException

Chain a given GPMessage.

Parameters:

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