com.esri.arcgis.geodatabase

Interface IGPMessages

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

IGPMessagesProxy

public interface IGPMessages
extends java.io.Serializable

COM Interface 'IGPMessages'. Generated 9/24/2024 11:01:29 AM from 'X:\ArcGIS\com\server\esriGeoDatabase.tlb'

Description: 'Provides access to Geoprocessor messages.' 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

Fields

Modifier and Type	Field and Description
static java.lang.String	IID Deprecated. Internal use only
static int	IID0696aa9d_c26b_4a3e_89b7_3763ea11f16c
static int	xxDummy Deprecated. Internal use only

Method Summary

Modifier and Type	Method and Description
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	clear() Clears the message objects from messages object.
IGPMessagesCallback	getCallback() The callback object associated with the GPMessages object.
int	getCount() The message count.
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	initializeMessages(int nMessages) Creates a number of empty messages and adds them to this messages object.
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	setCallbackByRef(IGPMessagesCallback messagesCallback) The callback object associated with the GPMessages object.

Field Detail

IID0696aa9d_c26b_4a3e_89b7_3763ea11f16c

static final int IID0696aa9d_c26b_4a3e_89b7_3763ea11f16c

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

setCallbackByRef

void setCallbackByRef(IGPMessagesCallback messagesCallback)
               throws java.io.IOException,
                      AutomationException

The callback object associated with the GPMessages object.

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

IGPMessagesCallback getCallback()
                         throws java.io.IOException,
                                AutomationException

The callback object associated with the GPMessages object.

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

void clear()
    throws java.io.IOException,
           AutomationException

Clears the message objects from messages object.

Throws:

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

AutomationException - If the ArcObject component throws an exception.

add

void add(IGPMessage msg)
  throws java.io.IOException,
         AutomationException

Adds a message object to the messages.

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

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

Adds a warning message to the messages.

Parameters:

message - The message (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addAbort

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

Adds an abort message to the messages.

Parameters:

message - The message (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addError

void addError(int errorCode,
              java.lang.String message)
       throws java.io.IOException,
              AutomationException

Adds an error message to the messages.

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

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

Adds an informative message to the messages.

Parameters:

message - The message (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addMessages

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

Adds all messages from an existing messages object to this 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.

initializeMessages

void initializeMessages(int nMessages)
                 throws java.io.IOException,
                        AutomationException

Creates a number of empty messages and adds them to this messages object.

Parameters:

nMessages - The nMessages (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

replace

void replace(int index,
             IGPMessage msg)
      throws java.io.IOException,
             AutomationException

Replace an existing message in a specified location with a new message object.

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

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.

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

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.

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

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.

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

void replaceMessage(int index,
                    java.lang.String message)
             throws java.io.IOException,
                    AutomationException

Creates message and replaces it into a specified position.

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

int getCount()
      throws java.io.IOException,
             AutomationException

The message count.

Returns:

The count

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMessage

IGPMessage getMessage(int index)
               throws java.io.IOException,
                      AutomationException

Provides a message object from the specified location.

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

IArray getMessages()
            throws java.io.IOException,
                   AutomationException

The array of message objects.

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

int getMaxSeverity()
            throws java.io.IOException,
                   AutomationException

The maximum message severity.

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.