com.esri.arcgis.geodatabase

Interface IGPMessage

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

IGPMessageProxy

public interface IGPMessage
extends java.io.Serializable

COM Interface 'IGPMessage'. Generated 4/9/2024 11:09:20 AM from 'X:\ArcGIS\com\server\esriGeoDatabase.tlb'

Description: 'Provides access to the properties of a Geoprocessor message.' 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	IID93d8accb_3a6e_4fa2_b283_197ee5d0e334
static int	xxDummy Deprecated. Internal use only

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDescription() The description of the geoprocessing message.
int	getErrorCode() The error code for the geoprocessing message.
int	getType() The geoprocessing message type.
boolean	isAbort() Indicates if the message is an abort.
boolean	isError() Indicates if the message is an error.
boolean	isInformational() Indicates if the message is informative.
boolean	isWarning() Indicates if the message is a warning.
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.

Field Detail

IID93d8accb_3a6e_4fa2_b283_197ee5d0e334

static final int IID93d8accb_3a6e_4fa2_b283_197ee5d0e334

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

setType

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

The geoprocessing message type.

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

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

The geoprocessing message type.

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

void setErrorCode(int errorCode)
           throws java.io.IOException,
                  AutomationException

The error code for the geoprocessing message.

Parameters:

errorCode - The errorCode (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getErrorCode

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

The error code for the geoprocessing message.

Returns:

The errorCode

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDescription

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

The description of the geoprocessing message.

Parameters:

message - The message (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDescription

java.lang.String getDescription()
                         throws java.io.IOException,
                                AutomationException

The description of the geoprocessing message.

Returns:

The message

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isInformational

boolean isInformational()
                 throws java.io.IOException,
                        AutomationException

Indicates if the message is informative.

Returns:

The isInformational

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isWarning

boolean isWarning()
           throws java.io.IOException,
                  AutomationException

Indicates if the message is a warning.

Returns:

The isWarning

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isError

boolean isError()
         throws java.io.IOException,
                AutomationException

Indicates if the message is an error.

Returns:

The isError

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isAbort

boolean isAbort()
         throws java.io.IOException,
                AutomationException

Indicates if the message is an abort.

Returns:

The isAbort

Throws:

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

AutomationException - If the ArcObject component throws an exception.