com.esri.arcgis.geoprocessing
Class GeoProcessorResult

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

All Implemented Interfaces:

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

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

COM Class 'GeoProcessorResult'. Generated 3/19/2015 1:20:44 PM from 'C:\ArcGIS\COM\esriGeoprocessing.olb'

Description 'GeoProcessorResult Access.' 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 =

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.esri.arcgis.geoprocessing.IGeoProcessorResult

IID, IIDe6f5ed50_72bb_42ae_b62f_b749185e2792, xxDummy

Fields inherited from interface com.esri.arcgis.geoprocessing.IGeoProcessorResult2

IID, IID23c0c81f_421a_44d9_a123_ae12b3c4e282, xxDummy

Constructor Summary

GeoProcessorResult()
Constructs a GeoProcessorResult using ArcGIS Engine.

GeoProcessorResult(java.lang.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(java.lang.Object o) Compare this object with another
static java.lang.String	getClsid() getClsid.
IGPValue	getInput(int index) Return the input by index.
int	getInputCount() Return the number of inputs.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
java.lang.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.
java.lang.String	getMessage(int index) Return the message description by index.
int	getMessageCount() Return the number of messages.
java.lang.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.
java.lang.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.
java.lang.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	release() Release a GeoProcessorResult.
void	setProcessByRef(IMdProcess process) Set the GeoProcessor process value.
void	setResultID(java.lang.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

Constructor Detail

GeoProcessorResult

public GeoProcessorResult()
                   throws java.io.IOException,
                          java.net.UnknownHostException

Constructs a GeoProcessorResult using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

GeoProcessorResult

public GeoProcessorResult(java.lang.Object obj)
                   throws java.io.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:

java.io.IOException - if there are interop problems

Method Detail

getClsid

public static java.lang.String getClsid()

getClsid.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()

Deprecated. Internal use only.

Specified by:

getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

release

public void release()

Release a GeoProcessorResult.

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

getReturnValue

public java.lang.Object getReturnValue()
                                throws java.io.IOException,
                                       AutomationException

Get the GeoProcessor return value.

Specified by:

getReturnValue in interface IGeoProcessorResult

Specified by:

getReturnValue in interface IGeoProcessorResult2

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getStatus

public int getStatus()
              throws java.io.IOException,
                     AutomationException

Get the job status.

Specified by:

getStatus in interface IGeoProcessorResult

Specified by:

getStatus in interface IGeoProcessorResult2

Returns:

A com.esri.arcgis.system.esriJobStatus constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getResultID

public java.lang.String getResultID()
                             throws java.io.IOException,
                                    AutomationException

Get the job ID.

Specified by:

getResultID in interface IGeoProcessorResult

Specified by:

getResultID in interface IGeoProcessorResult2

Returns:

The resultID

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getResultMessages

public IGPMessages getResultMessages()
                              throws java.io.IOException,
                                     AutomationException

Return the GPMessages object which will be messages.

Specified by:

getResultMessages in interface IGeoProcessorResult

Specified by:

getResultMessages in interface IGeoProcessorResult2

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMessageCount

public int getMessageCount()
                    throws java.io.IOException,
                           AutomationException

Return the number of messages.

Specified by:

getMessageCount in interface IGeoProcessorResult

Specified by:

getMessageCount in interface IGeoProcessorResult2

Returns:

The pCount

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMessage

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

Return the message description by index.

Specified by:

getMessage in interface IGeoProcessorResult

Specified by:

getMessage in interface IGeoProcessorResult2

Parameters:

index - The index (in)

Returns:

The pMessage

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSeverity

public int getSeverity(int index)
                throws java.io.IOException,
                       AutomationException

Return the message severity by index.

Specified by:

getSeverity in interface IGeoProcessorResult

Specified by:

getSeverity in interface IGeoProcessorResult2

Parameters:

index - The index (in)

Returns:

The pSeverity

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getReturnCode

public int getReturnCode(int index)
                  throws java.io.IOException,
                         AutomationException

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

Specified by:

getReturnCode in interface IGeoProcessorResult

Specified by:

getReturnCode in interface IGeoProcessorResult2

Parameters:

index - The index (in)

Returns:

The pCode

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMessages

public java.lang.String getMessages(int severity)
                             throws java.io.IOException,
                                    AutomationException

Return all of the message descriptions.

Specified by:

getMessages in interface IGeoProcessorResult

Specified by:

getMessages in interface IGeoProcessorResult2

Parameters:

severity - The severity (in)

Returns:

The pMessages

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMaxSeverity

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

Return the maximum severity of the message.

Specified by:

getMaxSeverity in interface IGeoProcessorResult

Specified by:

getMaxSeverity in interface IGeoProcessorResult2

Returns:

The pSeverity

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getOutputCount

public int getOutputCount()
                   throws java.io.IOException,
                          AutomationException

Return the number of outputs.

Specified by:

getOutputCount in interface IGeoProcessorResult

Specified by:

getOutputCount in interface IGeoProcessorResult2

Returns:

The pCount

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getOutput

public IGPValue getOutput(int index)
                   throws java.io.IOException,
                          AutomationException

Return the output by index.

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:

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

AutomationException - If the ArcObject component throws an exception.

getInputCount

public int getInputCount()
                  throws java.io.IOException,
                         AutomationException

Return the number of inputs.

Specified by:

getInputCount in interface IGeoProcessorResult

Specified by:

getInputCount in interface IGeoProcessorResult2

Returns:

The pCount

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getInput

public IGPValue getInput(int index)
                  throws java.io.IOException,
                         AutomationException

Return the input by index.

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:

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

AutomationException - If the ArcObject component throws an exception.

cancel

public void cancel()
            throws java.io.IOException,
                   AutomationException

Cancel the job.

Specified by:

cancel in interface IGeoProcessorResult

Specified by:

cancel in interface IGeoProcessorResult2

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMapImageURL

public java.lang.String getMapImageURL(ILongArray pParamIndexes,
                                       int height,
                                       int width,
                                       int resolution)
                                throws java.io.IOException,
                                       AutomationException

Delete the job and all associated data.

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:

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

AutomationException - If the ArcObject component throws an exception.

setStatus

public void setStatus(int status)
               throws java.io.IOException,
                      AutomationException

Get the job status.

Specified by:

setStatus in interface IGeoProcessorResult2

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setResultID

public void setResultID(java.lang.String resultID)
                 throws java.io.IOException,
                        AutomationException

Get the job ID.

Specified by:

setResultID in interface IGeoProcessorResult2

Parameters:

resultID - The resultID (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getProcess

public IMdProcess getProcess()
                      throws java.io.IOException,
                             AutomationException

Set the GeoProcessor process value.

Specified by:

getProcess in interface IGeoProcessorResult2

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setProcessByRef

public void setProcessByRef(IMdProcess process)
                     throws java.io.IOException,
                            AutomationException

Set the GeoProcessor process value.

Specified by:

setProcessByRef in interface IGeoProcessorResult2

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isCanceled

public boolean isCanceled()
                   throws java.io.IOException,
                          AutomationException

Get the GeoProcessor return value.

Specified by:

isCanceled in interface IGeoProcessorResult2

Returns:

The isCanceled

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isAsync

public boolean isAsync()
                throws java.io.IOException,
                       AutomationException

Get the GeoProcessor ASync status.

Specified by:

isAsync in interface IGeoProcessorResult2

Returns:

The isAsync

Throws:

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

AutomationException - If the ArcObject component throws an exception.