com.esri.arcgis.geoprocessing
Interface IGPToolCommandHelper

All Superinterfaces:

java.io.Serializable

All Known Subinterfaces:

IGPToolCommandHelper2

All Known Implementing Classes:

IGPToolCommandHelper2Proxy, IGPToolCommandHelperProxy

public interface IGPToolCommandHelper
extends java.io.Serializable

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

Description: 'Provides access to the properties and methods of a Geoprocessing Tool Command 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	IID86d8caa9_6035_4ac9_9cdc_6c9ed6eafcea
static int	xxDummy Deprecated. Internal use only

Method Summary

IGPTool	getTool() The geoprocessing tool currently associated with the command.
void	setTool(IGPTool tool) Associates the command object with a particular tool to be executed when the command is invoked.
void	setToolByName(java.lang.String toolbox, java.lang.String tool) Associates the command object with a particular tool to be executed when the command is invoked.

Field Detail

IID86d8caa9_6035_4ac9_9cdc_6c9ed6eafcea

static final int IID86d8caa9_6035_4ac9_9cdc_6c9ed6eafcea

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

setTool

void setTool(IGPTool tool)
             throws java.io.IOException,
                    AutomationException

Associates the command object with a particular tool to be executed when the command is invoked.

Parameters:

tool - A reference to a com.esri.arcgis.geoprocessing.IGPTool (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setToolByName

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

Associates the command object with a particular tool to be executed when the command is invoked.

Parameters:

toolbox - The toolbox (in)

tool - The tool (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTool

IGPTool getTool()
                throws java.io.IOException,
                       AutomationException

The geoprocessing tool currently associated with the command.

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.