com.esri.arcgis.geoprocessing
Interface IGPServer

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

GPServer, GPServerIP, GPServerLP, IGPServerProxy

public interface IGPServer
extends java.io.Serializable

COM Interface 'IGPServer'. 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	IID234f4a93_8516_4247_914c_57c59f1d3f5f
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 pOptions) 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.
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.
int	getJobStatus(java.lang.String jobID) Returns the status of the specified 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) Submits the specified tool with the supplied values and options and returns the job id.

Field Detail

IID234f4a93_8516_4247_914c_57c59f1d3f5f

static final int IID234f4a93_8516_4247_914c_57c59f1d3f5f

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 pOptions)
                  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)

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.

submitJob

java.lang.String submitJob(java.lang.String toolName,
                           IGPValues values)
                           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)

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.