com.esri.arcgis.geoprocessing
Interface IGPComHelper

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

GpDispatch, IGPComHelperProxy

public interface IGPComHelper
extends java.io.Serializable

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

Description: 'Provides access to properties and methods on a Geoprocessing helper 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	IID1e54e6b6_c2b0_470f_b030_d81d9464f3b3
static int	xxDummy Deprecated. Internal use only

Method Summary

void	addToolbox(java.lang.String toolbox) Adds a reference to the specified toolbox to the GeoProcessor.
IGPMessages	execute(java.lang.String toolName, IPropertySet params, ITrackCancel trackCancel) Executes the specified tool.
IGPEnvironmentManager	getEnvironmentManager() The environment manager object associated with the helper.
java.lang.String	getParameterName(java.lang.String toolName, int index) Get the parameter name for a given tool and index.
void	removeToolbox(java.lang.String toolbox) Removes the reference to the specified toolbox from the GeoProcessor.

Field Detail

IID1e54e6b6_c2b0_470f_b030_d81d9464f3b3

static final int IID1e54e6b6_c2b0_470f_b030_d81d9464f3b3

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

execute

IGPMessages execute(java.lang.String toolName,
                    IPropertySet params,
                    ITrackCancel trackCancel)
                    throws java.io.IOException,
                           AutomationException

Executes the specified tool.

Parameters:

toolName - The toolName (in)

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

trackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)

Returns:

A reference to a com.esri.arcgis.geodatabase.IGPMessages

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getParameterName

java.lang.String getParameterName(java.lang.String toolName,
                                  int index)
                                  throws java.io.IOException,
                                         AutomationException

Get the parameter name for a given tool and index.

Parameters:

toolName - The toolName (in)

index - The index (in)

Returns:

The paramName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addToolbox

void addToolbox(java.lang.String toolbox)
                throws java.io.IOException,
                       AutomationException

Adds a reference to the specified toolbox to the GeoProcessor.

Parameters:

toolbox - The toolbox (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

removeToolbox

void removeToolbox(java.lang.String toolbox)
                   throws java.io.IOException,
                          AutomationException

Removes the reference to the specified toolbox from the GeoProcessor.

Parameters:

toolbox - The toolbox (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getEnvironmentManager

IGPEnvironmentManager getEnvironmentManager()
                                            throws java.io.IOException,
                                                   AutomationException

The environment manager object associated with the helper.

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.