|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IGPTool
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 |
---|
static final int IID252c58fd_4042_4628_a9d0_de54c158ba55
static final int xxDummy
static final java.lang.String IID
Method Detail |
---|
java.lang.String getName() throws java.io.IOException, AutomationException
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setName(java.lang.String displayName) throws java.io.IOException, AutomationException
displayName
- The displayName (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.java.lang.String getDisplayName() throws java.io.IOException, AutomationException
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setDisplayName(java.lang.String displayName) throws java.io.IOException, AutomationException
displayName
- The displayName (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.java.lang.String getDescription() throws java.io.IOException, AutomationException
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setDescription(java.lang.String description) throws java.io.IOException, AutomationException
description
- The description (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.java.lang.String getToolCategory() throws java.io.IOException, AutomationException
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setToolCategory(java.lang.String category) throws java.io.IOException, AutomationException
category
- The category (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.IGPToolbox getToolbox() throws java.io.IOException, AutomationException
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.int getToolType() throws java.io.IOException, AutomationException
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.boolean isValid() throws java.io.IOException, AutomationException
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.boolean isLicensedForProduct() throws java.io.IOException, AutomationException
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.boolean isLicensed() throws java.io.IOException, AutomationException
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.boolean isDeleted() throws java.io.IOException, AutomationException
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.boolean canAlter() throws java.io.IOException, AutomationException
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.boolean canEditSource() throws java.io.IOException, AutomationException
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.IArray getParameterInfo() throws java.io.IOException, AutomationException
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.IUID getDialogCLSID() throws java.io.IOException, AutomationException
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void store() throws java.io.IOException, AutomationException
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.IGPMessages validate(IArray paramvalues, boolean updateValues, IGPEnvironmentManager pEnvMgr) throws java.io.IOException, AutomationException
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)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void execute(IArray paramvalues, ITrackCancel trackCancel, IGPEnvironmentManager pEnvMgr, IGPMessages messages) throws java.io.IOException, AutomationException
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)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.boolean editProperties(int hParent, IGPEnvironmentManager gPEnvMgr) throws java.io.IOException, AutomationException
hParent
- The hParent (A COM typedef) (in)gPEnvMgr
- A reference to a com.esri.arcgis.geoprocessing.IGPEnvironmentManager (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.java.lang.Object getRenderer(IGPParameter pParam) throws java.io.IOException, AutomationException
pParam
- A reference to a com.esri.arcgis.geoprocessing.IGPParameter (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.java.lang.String getPathName() throws java.io.IOException, AutomationException
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.boolean isRelativePaths() throws java.io.IOException, AutomationException
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setRelativePaths(boolean relPaths) throws java.io.IOException, AutomationException
relPaths
- The relPaths (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.java.lang.String getHelpFile() throws java.io.IOException, AutomationException
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setHelpFile(java.lang.String file) throws java.io.IOException, AutomationException
file
- The file (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.int getHelpContext() throws java.io.IOException, AutomationException
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setHelpContext(int context) throws java.io.IOException, AutomationException
context
- The context (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |