com.esri.arcgis.geoprocessing
Interface IGPTask

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

IGPTaskProxy

public interface IGPTask
extends java.io.Serializable

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

Description: 'Provides access to properties/methods of a task object.' 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	IIDf25fa93f_27ff_4698_889d_115904e429ab
static int	xxDummy Deprecated. Internal use only

Method Summary

int	getMode() The task mode.
java.lang.String	getParameterDescription(java.lang.String name) Get the parameter description.
void	getParameterInfo(java.lang.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.
java.lang.Object	getRenderer(java.lang.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(java.lang.String name, java.lang.String desc) Set the parameter description.
void	setParameterInfo(java.lang.String name, boolean visible, IGPParameter pParameter, IGPDomain pDomain) Set the parameter info.
void	setProcessByRef(IMdProcess process) The task process.
void	setRenderer(java.lang.String name, java.lang.Object pRenderer) Set the parameter renderer.

Field Detail

IIDf25fa93f_27ff_4698_889d_115904e429ab

static final int IIDf25fa93f_27ff_4698_889d_115904e429ab

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

init

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

Initialize the task.

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.

initPackage

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

Initialize the task.

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.

getMode

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

The task mode.

Returns:

The mode

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getProcess

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

The task process.

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

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

The task process.

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.

getParameterMapping

IPropertySet getParameterMapping()
                                 throws java.io.IOException,
                                        AutomationException

The parameter mapping associated with the task.

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.

getParameterInfo

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

Get the parameter info.

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:

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

AutomationException - If the ArcObject component throws an exception.

setParameterInfo

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

Set the parameter info.

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:

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

AutomationException - If the ArcObject component throws an exception.

getRenderer

java.lang.Object getRenderer(java.lang.String name)
                             throws java.io.IOException,
                                    AutomationException

Get the parameter renderer.

Parameters:

name - The name (in)

Returns:

A reference to another Object (IUnknown)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setRenderer

void setRenderer(java.lang.String name,
                 java.lang.Object pRenderer)
                 throws java.io.IOException,
                        AutomationException

Set the parameter renderer.

Parameters:

name - The name (in)

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isHasWorkspace

boolean isHasWorkspace()
                       throws java.io.IOException,
                              AutomationException

Set the parameter renderer.

Returns:

The pHasWorkspace

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setHasWorkspace

void setHasWorkspace(boolean pHasWorkspace)
                     throws java.io.IOException,
                            AutomationException

Set the parameter renderer.

Parameters:

pHasWorkspace - The pHasWorkspace (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getParameterDescription

java.lang.String getParameterDescription(java.lang.String name)
                                         throws java.io.IOException,
                                                AutomationException

Get the parameter description.

Parameters:

name - The name (in)

Returns:

The desc

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setParameterDescription

void setParameterDescription(java.lang.String name,
                             java.lang.String desc)
                             throws java.io.IOException,
                                    AutomationException

Set the parameter description.

Parameters:

name - The name (in)

desc - The desc (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.