com.esri.arcgis.geoprocessing
Interface IGeoProcessorResult2

All Superinterfaces:

Serializable

All Known Implementing Classes:

GeoProcessorResult

public interface IGeoProcessorResult2
extends Serializable

The Geoprocessor Result. Provides access to the results of tools.

Description

This interface is new at ArcGIS 10. It supersedes IGeoProcessorResult.

Product Availability

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

Method Summary

void	cancel() Cancel the job.
IGPValue	getInput(int index) Return the input by index.
int	getInputCount() Return the number of inputs.
String	getMapImageURL(ILongArray pParamIndexes, int height, int width, int resolution) Delete the job and all associated data.
int	getMaxSeverity() Return the maximum severity of the message.
String	getMessage(int index) Return the message description by index.
int	getMessageCount() Return the number of messages.
String	getMessages(int severity) Return all of the message descriptions.
IGPValue	getOutput(int index) Return the output by index.
int	getOutputCount() Return the number of outputs.
IMdProcess	getProcess() Set the GeoProcessor process value.
String	getResultID() Get the job ID.
IGPMessages	getResultMessages() Return the GPMessages object which will be messages.
int	getReturnCode(int index) Return the message error code (Error Messages Only) by index.
Object	getReturnValue() Get the GeoProcessor return value.
int	getSeverity(int index) Return the message severity by index.
int	getStatus() Get the job status.
boolean	isAsync() Get the GeoProcessor ASync status.
boolean	isCanceled() Get the GeoProcessor return value.
void	setProcessByRef(IMdProcess process) Set the GeoProcessor process value.
void	setResultID(String resultID) Get the job ID.
void	setStatus(int status) Get the job status.

Method Detail

getReturnValue

Object getReturnValue()
                      throws IOException,
                             AutomationException

Get the GeoProcessor return value.

Product Availability

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

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStatus

int getStatus()
              throws IOException,
                     AutomationException

Get the job status.

Product Availability

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

Returns:

A com.esri.arcgis.system.esriJobStatus constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getResultID

String getResultID()
                   throws IOException,
                          AutomationException

Get the job ID.

Product Availability

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

Returns:

The resultID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getResultMessages

IGPMessages getResultMessages()
                              throws IOException,
                                     AutomationException

Return the GPMessages object which will be messages.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.geodatabase.IGPMessages

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMessageCount

int getMessageCount()
                    throws IOException,
                           AutomationException

Return the number of messages.

Product Availability

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

Returns:

The pCount

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMessage

String getMessage(int index)
                  throws IOException,
                         AutomationException

Return the message description by index.

Product Availability

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

Parameters:

index - The index (in)

Returns:

The pMessage

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSeverity

int getSeverity(int index)
                throws IOException,
                       AutomationException

Return the message severity by index.

Product Availability

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

Parameters:

index - The index (in)

Returns:

The pSeverity

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getReturnCode

int getReturnCode(int index)
                  throws IOException,
                         AutomationException

Return the message error code (Error Messages Only) by index.

Product Availability

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

Parameters:

index - The index (in)

Returns:

The pCode

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMessages

String getMessages(int severity)
                   throws IOException,
                          AutomationException

Return all of the message descriptions.

Product Availability

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

Parameters:

severity - The severity (in)

Returns:

The pMessages

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMaxSeverity

int getMaxSeverity()
                   throws IOException,
                          AutomationException

Return the maximum severity of the message.

Product Availability

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

Returns:

The pSeverity

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOutputCount

int getOutputCount()
                   throws IOException,
                          AutomationException

Return the number of outputs.

Product Availability

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

Returns:

The pCount

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOutput

IGPValue getOutput(int index)
                   throws IOException,
                          AutomationException

Return the output by index.

Product Availability

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

Parameters:

index - The index (in)

Returns:

A reference to a com.esri.arcgis.geodatabase.IGPValue

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getInputCount

int getInputCount()
                  throws IOException,
                         AutomationException

Return the number of inputs.

Product Availability

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

Returns:

The pCount

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getInput

IGPValue getInput(int index)
                  throws IOException,
                         AutomationException

Return the input by index.

Product Availability

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

Parameters:

index - The index (in)

Returns:

A reference to a com.esri.arcgis.geodatabase.IGPValue

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

cancel

void cancel()
            throws IOException,
                   AutomationException

Cancel the job.

Product Availability

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMapImageURL

String getMapImageURL(ILongArray pParamIndexes,
                      int height,
                      int width,
                      int resolution)
                      throws IOException,
                             AutomationException

Delete the job and all associated data.

Product Availability

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

Parameters:

pParamIndexes - A reference to a com.esri.arcgis.system.ILongArray (in)

height - The height (in)

width - The width (in)

resolution - The resolution (in)

Returns:

The uRL

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setStatus

void setStatus(int status)
               throws IOException,
                      AutomationException

Get the job status.

Product Availability

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

Parameters:

status - A com.esri.arcgis.system.esriJobStatus constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setResultID

void setResultID(String resultID)
                 throws IOException,
                        AutomationException

Get the job ID.

Product Availability

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

Parameters:

resultID - The resultID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getProcess

IMdProcess getProcess()
                      throws IOException,
                             AutomationException

Set the GeoProcessor process value.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.geoprocessing.IMdProcess

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setProcessByRef

void setProcessByRef(IMdProcess process)
                     throws IOException,
                            AutomationException

Set the GeoProcessor process value.

Product Availability

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

Parameters:

process - A reference to a com.esri.arcgis.geoprocessing.IMdProcess (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isCanceled

boolean isCanceled()
                   throws IOException,
                          AutomationException

Get the GeoProcessor return value.

Description

Indicates that the IGeoProcessorResult2.Cancel method has been called. Use IGeoProcessorResult2.Status to determine whether the tool is still cancelling or has been cancelled.

Product Availability

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

Returns:

The isCanceled

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isAsync

boolean isAsync()
                throws IOException,
                       AutomationException

Get the GeoProcessor ASync status.

Product Availability

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

Returns:

The isAsync

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.