com.esri.arcgis.geoprocessing
Class GeoProcessorResult

java.lang.Object
  com.esri.arcgis.geoprocessing.GeoProcessorResult

All Implemented Interfaces:

IGeoProcessorResult, IGeoProcessorResult2, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class GeoProcessorResult
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IGeoProcessorResult, IGeoProcessorResult2

GeoProcessorResult Access.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

GeoProcessorResult()
Constructs a GeoProcessorResult using ArcGIS Engine.

GeoProcessorResult(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
GeoProcessorResult theGeoProcessorResult = (GeoProcessorResult) obj;

Method Summary

void	cancel() Cancel the job.
boolean	equals(Object o) Compare this object with another
static String	getClsid() getClsid.
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.
int	hashCode() the hashcode for this object
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.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

GeoProcessorResult

public GeoProcessorResult()
                   throws IOException,
                          UnknownHostException

Constructs a GeoProcessorResult using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

GeoProcessorResult

public GeoProcessorResult(Object obj)
                   throws IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
GeoProcessorResult theGeoProcessorResult = (GeoProcessorResult) obj;

Construct a GeoProcessorResult using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to GeoProcessorResult.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

getReturnValue

public Object getReturnValue()
                      throws IOException,
                             AutomationException

Get the GeoProcessor return value.

Product Availability

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

Specified by:

getReturnValue in interface IGeoProcessorResult

Specified by:

getReturnValue in interface IGeoProcessorResult2

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStatus

public int getStatus()
              throws IOException,
                     AutomationException

Get the job status.

Product Availability

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

Specified by:

getStatus in interface IGeoProcessorResult

Specified by:

getStatus in interface IGeoProcessorResult2

Returns:

A com.esri.arcgis.system.esriJobStatus constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getResultID

public String getResultID()
                   throws IOException,
                          AutomationException

Get the job ID.

Product Availability

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

Specified by:

getResultID in interface IGeoProcessorResult

Specified by:

getResultID in interface IGeoProcessorResult2

Returns:

The resultID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getResultMessages

public IGPMessages getResultMessages()
                              throws IOException,
                                     AutomationException

Return the GPMessages object which will be messages.

Product Availability

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

Specified by:

getResultMessages in interface IGeoProcessorResult

Specified by:

getResultMessages in interface IGeoProcessorResult2

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

public int getMessageCount()
                    throws IOException,
                           AutomationException

Return the number of messages.

Product Availability

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

Specified by:

getMessageCount in interface IGeoProcessorResult

Specified by:

getMessageCount in interface IGeoProcessorResult2

Returns:

The pCount

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMessage

public String getMessage(int index)
                  throws IOException,
                         AutomationException

Return the message description by index.

Product Availability

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

Specified by:

getMessage in interface IGeoProcessorResult

Specified by:

getMessage in interface IGeoProcessorResult2

Parameters:

index - The index (in)

Returns:

The pMessage

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSeverity

public int getSeverity(int index)
                throws IOException,
                       AutomationException

Return the message severity by index.

Product Availability

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

Specified by:

getSeverity in interface IGeoProcessorResult

Specified by:

getSeverity in interface IGeoProcessorResult2

Parameters:

index - The index (in)

Returns:

The pSeverity

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getReturnCode

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

Specified by:

getReturnCode in interface IGeoProcessorResult

Specified by:

getReturnCode in interface IGeoProcessorResult2

Parameters:

index - The index (in)

Returns:

The pCode

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMessages

public String getMessages(int severity)
                   throws IOException,
                          AutomationException

Return all of the message descriptions.

Product Availability

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

Specified by:

getMessages in interface IGeoProcessorResult

Specified by:

getMessages in interface IGeoProcessorResult2

Parameters:

severity - The severity (in)

Returns:

The pMessages

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMaxSeverity

public int getMaxSeverity()
                   throws IOException,
                          AutomationException

Return the maximum severity of the message.

Product Availability

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

Specified by:

getMaxSeverity in interface IGeoProcessorResult

Specified by:

getMaxSeverity in interface IGeoProcessorResult2

Returns:

The pSeverity

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOutputCount

public int getOutputCount()
                   throws IOException,
                          AutomationException

Return the number of outputs.

Product Availability

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

Specified by:

getOutputCount in interface IGeoProcessorResult

Specified by:

getOutputCount in interface IGeoProcessorResult2

Returns:

The pCount

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOutput

public IGPValue getOutput(int index)
                   throws IOException,
                          AutomationException

Return the output by index.

Product Availability

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

Specified by:

getOutput in interface IGeoProcessorResult

Specified by:

getOutput in interface IGeoProcessorResult2

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

public int getInputCount()
                  throws IOException,
                         AutomationException

Return the number of inputs.

Product Availability

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

Specified by:

getInputCount in interface IGeoProcessorResult

Specified by:

getInputCount in interface IGeoProcessorResult2

Returns:

The pCount

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getInput

public IGPValue getInput(int index)
                  throws IOException,
                         AutomationException

Return the input by index.

Product Availability

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

Specified by:

getInput in interface IGeoProcessorResult

Specified by:

getInput in interface IGeoProcessorResult2

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

public void cancel()
            throws IOException,
                   AutomationException

Cancel the job.

Product Availability

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

Specified by:

cancel in interface IGeoProcessorResult

Specified by:

cancel in interface IGeoProcessorResult2

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMapImageURL

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

Specified by:

getMapImageURL in interface IGeoProcessorResult

Specified by:

getMapImageURL in interface IGeoProcessorResult2

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

public void setStatus(int status)
               throws IOException,
                      AutomationException

Get the job status.

Product Availability

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

Specified by:

setStatus in interface IGeoProcessorResult2

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

public void setResultID(String resultID)
                 throws IOException,
                        AutomationException

Get the job ID.

Product Availability

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

Specified by:

setResultID in interface IGeoProcessorResult2

Parameters:

resultID - The resultID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getProcess

public IMdProcess getProcess()
                      throws IOException,
                             AutomationException

Set the GeoProcessor process value.

Product Availability

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

Specified by:

getProcess in interface IGeoProcessorResult2

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

public void setProcessByRef(IMdProcess process)
                     throws IOException,
                            AutomationException

Set the GeoProcessor process value.

Product Availability

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

Specified by:

setProcessByRef in interface IGeoProcessorResult2

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

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

Specified by:

isCanceled in interface IGeoProcessorResult2

Returns:

The isCanceled

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isAsync

public boolean isAsync()
                throws IOException,
                       AutomationException

Get the GeoProcessor ASync status.

Product Availability

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

Specified by:

isAsync in interface IGeoProcessorResult2

Returns:

The isAsync

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.