com.esri.arcgis.geoprocessing
Interface IGPServer2

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

GPServer, GPServerIP, GPServerLP, IGPServer2Proxy

public interface IGPServer2
extends java.io.Serializable

COM Interface 'IGPServer2'. Generated 3/19/2015 1:20:59 PM from 'C:\ArcGIS\COM\esriGeoprocessing.olb'

Description: 'Provides access to the properties/methods of the geoprocessing server.' 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

static java.lang.String	IID Deprecated. Internal use only
static int	IID27909bc6_7ad1_4f5a_8e90_1bb8b95a569f
static int	xxDummy Deprecated. Internal use only

Method Summary

void	cancelJob(java.lang.String jobID) Cancels the specified job.
IGPResult	execute(java.lang.String toolName, IGPValues values, IGPResultOptions options, IPropertySet envValues) Executes the specified tool with the supplied values and options and returns the results.
int	getExecutionType() Indicates if the geoprocessing server is synchronous or asynchronous.
IPropertySet	getJobEnvironmentValues(java.lang.String jobID) Returns the enviornment values for the job.
IGPValues	getJobInputValues(java.lang.String jobID, IStringArray parameterNames) Returns the input values for the job.
IJobMessages	getJobMessages(java.lang.String jobID) Returns the messages of the specified job.
IGPResult	getJobResult(java.lang.String jobID, IStringArray parameterNames, IGPResultOptions pOptions) Returns the results of the specified job.
IEnvelope	getJobResultMapExtent(java.lang.String jobID) Returns the extent for the job.
IGPResultOptions	getJobResultOptions(java.lang.String jobID) Returns the result options for the job.
int	getJobStatus(java.lang.String jobID) Returns the status of the specified job.
java.lang.String	getJobToolName(java.lang.String jobID) Returns the tool name for the job.
java.lang.String	getResultMapServerName() Indicates if there is an associated map server to draw the results and the name of the map server.
IGDSData	getResultWorkspace(java.lang.String jobID, int transportType) Returns a zip file of the results workspace.
IGPToolInfos	getTaskInfos() Returns the tool information of the available tasks.
IStringArray	getTaskNames() Returns the names of the available tasks.
IGPToolInfo	getToolInfo(java.lang.String toolName) Returns the tool information of the specified tool name.
IGPToolInfos	getToolInfos() Returns the tool information of the available tools.
IStringArray	getToolNames() Returns the names of the available tools.
java.lang.String	submitJob(java.lang.String toolName, IGPValues values, IGPResultOptions options, IPropertySet envValues) Submits the specified tool with the supplied values and options and returns the job id.

Field Detail

IID27909bc6_7ad1_4f5a_8e90_1bb8b95a569f

static final int IID27909bc6_7ad1_4f5a_8e90_1bb8b95a569f

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

getToolNames

IStringArray getToolNames()
                          throws java.io.IOException,
                                 AutomationException

Returns the names of the available tools.

Returns:

A reference to a com.esri.arcgis.system.IStringArray

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getToolInfos

IGPToolInfos getToolInfos()
                          throws java.io.IOException,
                                 AutomationException

Returns the tool information of the available tools.

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getToolInfo

IGPToolInfo getToolInfo(java.lang.String toolName)
                        throws java.io.IOException,
                               AutomationException

Returns the tool information of the specified tool name.

Parameters:

toolName - The toolName (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTaskNames

IStringArray getTaskNames()
                          throws java.io.IOException,
                                 AutomationException

Returns the names of the available tasks.

Returns:

A reference to a com.esri.arcgis.system.IStringArray

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTaskInfos

IGPToolInfos getTaskInfos()
                          throws java.io.IOException,
                                 AutomationException

Returns the tool information of the available tasks.

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getResultMapServerName

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

Indicates if there is an associated map server to draw the results and the name of the map server.

Returns:

The mapServerName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

execute

IGPResult execute(java.lang.String toolName,
                  IGPValues values,
                  IGPResultOptions options,
                  IPropertySet envValues)
                  throws java.io.IOException,
                         AutomationException

Executes the specified tool with the supplied values and options and returns the results.

Parameters:

toolName - The toolName (in)

values - A reference to a com.esri.arcgis.geoprocessing.IGPValues (in)

options - A reference to a com.esri.arcgis.geoprocessing.IGPResultOptions (in)

envValues - A reference to a com.esri.arcgis.system.IPropertySet (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

submitJob

java.lang.String submitJob(java.lang.String toolName,
                           IGPValues values,
                           IGPResultOptions options,
                           IPropertySet envValues)
                           throws java.io.IOException,
                                  AutomationException

Submits the specified tool with the supplied values and options and returns the job id.

Parameters:

toolName - The toolName (in)

values - A reference to a com.esri.arcgis.geoprocessing.IGPValues (in)

options - A reference to a com.esri.arcgis.geoprocessing.IGPResultOptions (in)

envValues - A reference to a com.esri.arcgis.system.IPropertySet (in)

Returns:

The jobID

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getJobStatus

int getJobStatus(java.lang.String jobID)
                 throws java.io.IOException,
                        AutomationException

Returns the status of the specified job.

Parameters:

jobID - The jobID (in)

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.

getJobMessages

IJobMessages getJobMessages(java.lang.String jobID)
                            throws java.io.IOException,
                                   AutomationException

Returns the messages of the specified job.

Parameters:

jobID - The jobID (in)

Returns:

A reference to a com.esri.arcgis.system.IJobMessages

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getJobResult

IGPResult getJobResult(java.lang.String jobID,
                       IStringArray parameterNames,
                       IGPResultOptions pOptions)
                       throws java.io.IOException,
                              AutomationException

Returns the results of the specified job.

Parameters:

jobID - The jobID (in)

parameterNames - A reference to a com.esri.arcgis.system.IStringArray (in)

pOptions - A reference to a com.esri.arcgis.geoprocessing.IGPResultOptions (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

cancelJob

void cancelJob(java.lang.String jobID)
               throws java.io.IOException,
                      AutomationException

Cancels the specified job.

Parameters:

jobID - The jobID (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getExecutionType

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

Indicates if the geoprocessing server is synchronous or asynchronous.

Returns:

A com.esri.arcgis.geoprocessing.esriExecutionType constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getResultWorkspace

IGDSData getResultWorkspace(java.lang.String jobID,
                            int transportType)
                            throws java.io.IOException,
                                   AutomationException

Returns a zip file of the results workspace.

Parameters:

jobID - The jobID (in)

transportType - A com.esri.arcgis.geodatabasedistributed.esriGDSTransportType constant (in)

Returns:

A reference to a com.esri.arcgis.geodatabasedistributed.IGDSData

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getJobToolName

java.lang.String getJobToolName(java.lang.String jobID)
                                throws java.io.IOException,
                                       AutomationException

Returns the tool name for the job.

Parameters:

jobID - The jobID (in)

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getJobInputValues

IGPValues getJobInputValues(java.lang.String jobID,
                            IStringArray parameterNames)
                            throws java.io.IOException,
                                   AutomationException

Returns the input values for the job.

Parameters:

jobID - The jobID (in)

parameterNames - A reference to a com.esri.arcgis.system.IStringArray (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getJobResultOptions

IGPResultOptions getJobResultOptions(java.lang.String jobID)
                                     throws java.io.IOException,
                                            AutomationException

Returns the result options for the job.

Parameters:

jobID - The jobID (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getJobEnvironmentValues

IPropertySet getJobEnvironmentValues(java.lang.String jobID)
                                     throws java.io.IOException,
                                            AutomationException

Returns the enviornment values for the job.

Parameters:

jobID - The jobID (in)

Returns:

A reference to a com.esri.arcgis.system.IPropertySet

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getJobResultMapExtent

IEnvelope getJobResultMapExtent(java.lang.String jobID)
                                throws java.io.IOException,
                                       AutomationException

Returns the extent for the job.

Parameters:

jobID - The jobID (in)

Returns:

A reference to a com.esri.arcgis.geometry.IEnvelope

Throws:

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

AutomationException - If the ArcObject component throws an exception.