com.esri.arcgis.geoprocessing
Interface IGPTool

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

IGPToolProxy

public interface IGPTool
extends java.io.Serializable

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

Description: 'Provides access to methods on a geoprocessing tool 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	IID252c58fd_4042_4628_a9d0_de54c158ba55
static int	xxDummy Deprecated. Internal use only

Method Summary

boolean	canAlter() Returns whether or not the properties of the tool can be modified.
boolean	canEditSource() Returns whether or not the source (i.e., definition) of the tool can be modified.
boolean	editProperties(int hParent, IGPEnvironmentManager gPEnvMgr) Presents a modal dialog to edit the tool's properties.
void	execute(IArray paramvalues, ITrackCancel trackCancel, IGPEnvironmentManager pEnvMgr, IGPMessages messages) Executes the tool with the given set of values.
java.lang.String	getDescription() The description of the tool.
IUID	getDialogCLSID() The class identifier of the custom dialog to use for this tool.
java.lang.String	getDisplayName() The display name of the tool.
int	getHelpContext() The context identifier of the topic within the help file for this tool.
java.lang.String	getHelpFile() Name of the (CHM) file containing help information for this tool.
java.lang.String	getName() The name of the tool.
IArray	getParameterInfo() The set of parameters required to execute the tool.
java.lang.String	getPathName() The path of the tool object.
java.lang.Object	getRenderer(IGPParameter pParam) Returns the renderer associated with the specified parameter.
IGPToolbox	getToolbox() The toolbox of the tool.
java.lang.String	getToolCategory() The tool category.
int	getToolType() The type of tool.
boolean	isDeleted() Indicates if the tool has been deleted.
boolean	isLicensed() Returns whether the tool is licensed to be executed.
boolean	isLicensedForProduct() Returns whether the tool is part of the current product.
boolean	isRelativePaths() Indicates if path names are stored relative to the tool/toolbox.
boolean	isValid() Returns whether the tool is capable of being executed/edited.
void	setDescription(java.lang.String description) The description of the tool.
void	setDisplayName(java.lang.String displayName) The display name of the tool.
void	setHelpContext(int context) The context identifier of the topic within the help file for this tool.
void	setHelpFile(java.lang.String file) Name of the (CHM) file containing help information for this tool.
void	setName(java.lang.String displayName) The name of the tool.
void	setRelativePaths(boolean relPaths) Indicates if path names are stored relative to the tool/toolbox.
void	setToolCategory(java.lang.String category) The tool category.
void	store() Stores the current state of the tool to the toolbox.
IGPMessages	validate(IArray paramvalues, boolean updateValues, IGPEnvironmentManager pEnvMgr) Validates the given set of values.

Field Detail

IID252c58fd_4042_4628_a9d0_de54c158ba55

static final int IID252c58fd_4042_4628_a9d0_de54c158ba55

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

getName

java.lang.String getName()
                         throws java.io.IOException,
                                AutomationException

The name of the tool.

Returns:

The displayName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setName

void setName(java.lang.String displayName)
             throws java.io.IOException,
                    AutomationException

The name of the tool.

Parameters:

displayName - The displayName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDisplayName

java.lang.String getDisplayName()
                                throws java.io.IOException,
                                       AutomationException

The display name of the tool.

Returns:

The displayName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDisplayName

void setDisplayName(java.lang.String displayName)
                    throws java.io.IOException,
                           AutomationException

The display name of the tool.

Parameters:

displayName - The displayName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDescription

java.lang.String getDescription()
                                throws java.io.IOException,
                                       AutomationException

The description of the tool.

Returns:

The description

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDescription

void setDescription(java.lang.String description)
                    throws java.io.IOException,
                           AutomationException

The description of the tool.

Parameters:

description - The description (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getToolCategory

java.lang.String getToolCategory()
                                 throws java.io.IOException,
                                        AutomationException

The tool category.

Returns:

The category

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setToolCategory

void setToolCategory(java.lang.String category)
                     throws java.io.IOException,
                            AutomationException

The tool category.

Parameters:

category - The category (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getToolbox

IGPToolbox getToolbox()
                      throws java.io.IOException,
                             AutomationException

The toolbox of the tool.

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getToolType

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

The type of tool.

Returns:

A com.esri.arcgis.geoprocessing.esriGPToolType constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isValid

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

Returns whether the tool is capable of being executed/edited.

Returns:

The valid

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isLicensedForProduct

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

Returns whether the tool is part of the current product.

Returns:

The isLicensed

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isLicensed

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

Returns whether the tool is licensed to be executed.

Returns:

The isLicensed

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isDeleted

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

Indicates if the tool has been deleted.

Returns:

The deleted

Throws:

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

AutomationException - If the ArcObject component throws an exception.

canAlter

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

Returns whether or not the properties of the tool can be modified.

Returns:

The canAlter

Throws:

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

AutomationException - If the ArcObject component throws an exception.

canEditSource

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

Returns whether or not the source (i.e., definition) of the tool can be modified.

Returns:

The canEdit

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getParameterInfo

IArray getParameterInfo()
                        throws java.io.IOException,
                               AutomationException

The set of parameters required to execute the tool.

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDialogCLSID

IUID getDialogCLSID()
                    throws java.io.IOException,
                           AutomationException

The class identifier of the custom dialog to use for this tool.

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

store

void store()
           throws java.io.IOException,
                  AutomationException

Stores the current state of the tool to the toolbox.

Throws:

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

AutomationException - If the ArcObject component throws an exception.

validate

IGPMessages validate(IArray paramvalues,
                     boolean updateValues,
                     IGPEnvironmentManager pEnvMgr)
                     throws java.io.IOException,
                            AutomationException

Validates the given set of values.

Parameters:

paramvalues - A reference to a com.esri.arcgis.system.IArray (in)

updateValues - The updateValues (in)

pEnvMgr - A reference to a com.esri.arcgis.geoprocessing.IGPEnvironmentManager (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.

execute

void execute(IArray paramvalues,
             ITrackCancel trackCancel,
             IGPEnvironmentManager pEnvMgr,
             IGPMessages messages)
             throws java.io.IOException,
                    AutomationException

Executes the tool with the given set of values.

Parameters:

paramvalues - A reference to a com.esri.arcgis.system.IArray (in)

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

pEnvMgr - A reference to a com.esri.arcgis.geoprocessing.IGPEnvironmentManager (in)

messages - A reference to a com.esri.arcgis.geodatabase.IGPMessages (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

editProperties

boolean editProperties(int hParent,
                       IGPEnvironmentManager gPEnvMgr)
                       throws java.io.IOException,
                              AutomationException

Presents a modal dialog to edit the tool's properties.

Parameters:

hParent - The hParent (A COM typedef) (in)

gPEnvMgr - A reference to a com.esri.arcgis.geoprocessing.IGPEnvironmentManager (in)

Returns:

The ok

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getRenderer

java.lang.Object getRenderer(IGPParameter pParam)
                             throws java.io.IOException,
                                    AutomationException

Returns the renderer associated with the specified parameter.

Parameters:

pParam - A reference to a com.esri.arcgis.geoprocessing.IGPParameter (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.

getPathName

java.lang.String getPathName()
                             throws java.io.IOException,
                                    AutomationException

The path of the tool object.

Returns:

The pathName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isRelativePaths

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

Indicates if path names are stored relative to the tool/toolbox.

Returns:

The relPaths

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setRelativePaths

void setRelativePaths(boolean relPaths)
                      throws java.io.IOException,
                             AutomationException

Indicates if path names are stored relative to the tool/toolbox.

Parameters:

relPaths - The relPaths (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getHelpFile

java.lang.String getHelpFile()
                             throws java.io.IOException,
                                    AutomationException

Name of the (CHM) file containing help information for this tool.

Returns:

The file

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setHelpFile

void setHelpFile(java.lang.String file)
                 throws java.io.IOException,
                        AutomationException

Name of the (CHM) file containing help information for this tool.

Parameters:

file - The file (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getHelpContext

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

The context identifier of the topic within the help file for this tool.

Returns:

The context

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setHelpContext

void setHelpContext(int context)
                    throws java.io.IOException,
                           AutomationException

The context identifier of the topic within the help file for this tool.

Parameters:

context - The context (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.