com.esri.arcgis.geoprocessing
Interface IGPServer2

All Superinterfaces:

Serializable

All Known Implementing Classes:

GPServer, GPServerIP, GPServerLP

public interface IGPServer2
extends Serializable

Provides access to the properties/methods of the geoprocessing server.

Description

This interface is new at ArcGIS 9.3. It supersedes IGPServer.

Product Availability

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

Method Summary

void	cancelJob(String jobID) Cancels the specified job.
IGPResult	execute(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(String jobID) Returns the enviornment values for the job.
IGPValues	getJobInputValues(String jobID, IStringArray parameterNames) Returns the input values for the job.
IJobMessages	getJobMessages(String jobID) Returns the messages of the specified job.
IGPResult	getJobResult(String jobID, IStringArray parameterNames, IGPResultOptions pOptions) Returns the results of the specified job.
IEnvelope	getJobResultMapExtent(String jobID) Returns the extent for the job.
IGPResultOptions	getJobResultOptions(String jobID) Returns the result options for the job.
int	getJobStatus(String jobID) Returns the status of the specified job.
String	getJobToolName(String jobID) Returns the tool name for the job.
String	getResultMapServerName() Indicates if there is an associated map server to draw the results and the name of the map server.
IGDSData	getResultWorkspace(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(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.
String	submitJob(String toolName, IGPValues values, IGPResultOptions options, IPropertySet envValues) Submits the specified tool with the supplied values and options and returns the job id.

Method Detail

getToolNames

IStringArray getToolNames()
                          throws IOException,
                                 AutomationException

Returns the names of the available tools.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getToolInfos

IGPToolInfos getToolInfos()
                          throws IOException,
                                 AutomationException

Returns the tool information of the available tools.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getToolInfo

IGPToolInfo getToolInfo(String toolName)
                        throws IOException,
                               AutomationException

Returns the tool information of the specified tool name.

Product Availability

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

Parameters:

toolName - The toolName (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTaskNames

IStringArray getTaskNames()
                          throws IOException,
                                 AutomationException

Returns the names of the available tasks.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTaskInfos

IGPToolInfos getTaskInfos()
                          throws IOException,
                                 AutomationException

Returns the tool information of the available tasks.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getResultMapServerName

String getResultMapServerName()
                              throws IOException,
                                     AutomationException

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

Product Availability

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

Returns:

The mapServerName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

execute

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

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

Product Availability

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

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:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

submitJob

String submitJob(String toolName,
                 IGPValues values,
                 IGPResultOptions options,
                 IPropertySet envValues)
                 throws IOException,
                        AutomationException

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

Product Availability

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

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:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getJobStatus

int getJobStatus(String jobID)
                 throws IOException,
                        AutomationException

Returns the status of the specified job.

Product Availability

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

Parameters:

jobID - The jobID (in)

Returns:

A com.esri.arcgis.system.esriJobStatus constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getJobMessages

IJobMessages getJobMessages(String jobID)
                            throws IOException,
                                   AutomationException

Returns the messages of the specified job.

Product Availability

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

Parameters:

jobID - The jobID (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getJobResult

IGPResult getJobResult(String jobID,
                       IStringArray parameterNames,
                       IGPResultOptions pOptions)
                       throws IOException,
                              AutomationException

Returns the results of the specified job.

Product Availability

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

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:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

cancelJob

void cancelJob(String jobID)
               throws IOException,
                      AutomationException

Cancels the specified job.

Product Availability

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

Parameters:

jobID - The jobID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getExecutionType

int getExecutionType()
                     throws IOException,
                            AutomationException

Indicates if the geoprocessing server is synchronous or asynchronous.

Product Availability

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

Returns:

A com.esri.arcgis.geoprocessing.esriExecutionType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getResultWorkspace

IGDSData getResultWorkspace(String jobID,
                            int transportType)
                            throws IOException,
                                   AutomationException

Returns a zip file of the results workspace.

Product Availability

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

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:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getJobToolName

String getJobToolName(String jobID)
                      throws IOException,
                             AutomationException

Returns the tool name for the job.

Product Availability

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

Parameters:

jobID - The jobID (in)

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getJobInputValues

IGPValues getJobInputValues(String jobID,
                            IStringArray parameterNames)
                            throws IOException,
                                   AutomationException

Returns the input values for the job.

Product Availability

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

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:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getJobResultOptions

IGPResultOptions getJobResultOptions(String jobID)
                                     throws IOException,
                                            AutomationException

Returns the result options for the job.

Product Availability

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

Parameters:

jobID - The jobID (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getJobEnvironmentValues

IPropertySet getJobEnvironmentValues(String jobID)
                                     throws IOException,
                                            AutomationException

Returns the enviornment values for the job.

Product Availability

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

Parameters:

jobID - The jobID (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getJobResultMapExtent

IEnvelope getJobResultMapExtent(String jobID)
                                throws IOException,
                                       AutomationException

Returns the extent for the job.

Product Availability

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

Parameters:

jobID - The jobID (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.