com.esri.arcgis.geoprocessing
Interface IGPTask

All Superinterfaces:

Serializable

public interface IGPTask
extends Serializable

Provides access to properties/methods of a task object.

Product Availability

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

Method Summary

int	getMode() The task mode.
String	getParameterDescription(String name) Get the parameter description.
void	getParameterInfo(String name, boolean[] visible, IGPParameter[] ppParameter, IGPDomain[] ppDomain) Get the parameter info.
IPropertySet	getParameterMapping() The parameter mapping associated with the task.
IMdProcess	getProcess() The task process.
Object	getRenderer(String name) Get the parameter renderer.
void	init(IMdProcess process) Initialize the task.
void	initPackage(IMdProcess process) Initialize the task.
boolean	isHasWorkspace() Set the parameter renderer.
void	setHasWorkspace(boolean pHasWorkspace) Set the parameter renderer.
void	setParameterDescription(String name, String desc) Set the parameter description.
void	setParameterInfo(String name, boolean visible, IGPParameter pParameter, IGPDomain pDomain) Set the parameter info.
void	setProcessByRef(IMdProcess process) The task process.
void	setRenderer(String name, Object pRenderer) Set the parameter renderer.

Method Detail

init

void init(IMdProcess process)
          throws IOException,
                 AutomationException

Initialize the task.

Product Availability

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

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.

initPackage

void initPackage(IMdProcess process)
                 throws IOException,
                        AutomationException

Initialize the task.

Product Availability

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

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.

getMode

int getMode()
            throws IOException,
                   AutomationException

The task mode.

Product Availability

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

Returns:

The mode

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getProcess

IMdProcess getProcess()
                      throws IOException,
                             AutomationException

The task process.

Product Availability

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

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

void setProcessByRef(IMdProcess process)
                     throws IOException,
                            AutomationException

The task process.

Product Availability

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

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.

getParameterMapping

IPropertySet getParameterMapping()
                                 throws IOException,
                                        AutomationException

The parameter mapping associated with the task.

Product Availability

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

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.

getParameterInfo

void getParameterInfo(String name,
                      boolean[] visible,
                      IGPParameter[] ppParameter,
                      IGPDomain[] ppDomain)
                      throws IOException,
                             AutomationException

Get the parameter info.

Product Availability

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

Parameters:

name - The name (in)

visible - The visible (out: use single element array)

ppParameter - A reference to a com.esri.arcgis.geoprocessing.IGPParameter (out: use single element array)

ppDomain - A reference to a com.esri.arcgis.geodatabase.IGPDomain (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setParameterInfo

void setParameterInfo(String name,
                      boolean visible,
                      IGPParameter pParameter,
                      IGPDomain pDomain)
                      throws IOException,
                             AutomationException

Set the parameter info.

Product Availability

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

Parameters:

name - The name (in)

visible - The visible (in)

pParameter - A reference to a com.esri.arcgis.geoprocessing.IGPParameter (in)

pDomain - A reference to a com.esri.arcgis.geodatabase.IGPDomain (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRenderer

Object getRenderer(String name)
                   throws IOException,
                          AutomationException

Get the parameter renderer.

Product Availability

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

Parameters:

name - The name (in)

Returns:

A reference to another Object (IUnknown)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRenderer

void setRenderer(String name,
                 Object pRenderer)
                 throws IOException,
                        AutomationException

Set the parameter renderer.

Product Availability

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

Parameters:

name - The name (in)

pRenderer - A reference to another Object (IUnknown) (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isHasWorkspace

boolean isHasWorkspace()
                       throws IOException,
                              AutomationException

Set the parameter renderer.

Product Availability

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

Returns:

The pHasWorkspace

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHasWorkspace

void setHasWorkspace(boolean pHasWorkspace)
                     throws IOException,
                            AutomationException

Set the parameter renderer.

Product Availability

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

Parameters:

pHasWorkspace - The pHasWorkspace (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getParameterDescription

String getParameterDescription(String name)
                               throws IOException,
                                      AutomationException

Get the parameter description.

Product Availability

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

Parameters:

name - The name (in)

Returns:

The desc

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setParameterDescription

void setParameterDescription(String name,
                             String desc)
                             throws IOException,
                                    AutomationException

Set the parameter description.

Product Availability

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

Parameters:

name - The name (in)

desc - The desc (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.