com.esri.arcgis.geoprocessing
Interface IGPToolbox

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

IGPToolboxProxy

public interface IGPToolbox
extends java.io.Serializable

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

Description: 'Provides access to methods on the toolbox 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	IID8df04717_e331_49d9_980b_1079d4e61e37
static int	xxDummy Deprecated. Internal use only

Method Summary

void	alterAlias(java.lang.String newAlias) Changes the alias of the toolbox.
void	alterHelpInfo(java.lang.String file, int context) Sets the help (CHM) file and help context identifier containing help for this toolbox.
boolean	canCreateTool() Returns whether or not a new tool can be created in the toolbox.
IGPTool	createTool(int type, java.lang.String name, java.lang.String displayName, java.lang.String description, java.lang.String toolCategory, IGPToolExtension toolExtension) Creates a new tool in the toolbox.
java.lang.String	getAlias() The alias of the toolbox, used when referencing a tool: name_alias.
int	getHelpContext() The context identifier of the topic within the help file for this toolbox.
java.lang.String	getHelpFile() The name of the (CHM) file containing help information for this toolbox.
java.lang.String	getPathName() The path name to the toolbox.
IEnumGPToolName	getToolNames() An enumeration of all the geoprocessing tool name objects contained within the toolbox.
IEnumGPTool	getTools() An enumeration of all the geoprocessing tools contained within the toolbox.
boolean	isDeleted() Indicates if the toolbox has been deleted.
IGPTool	openTool(java.lang.String name) Returns a specific tool (by name) within the toolbox.

Field Detail

IID8df04717_e331_49d9_980b_1079d4e61e37

static final int IID8df04717_e331_49d9_980b_1079d4e61e37

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

getPathName

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

The path name to the toolbox.

Returns:

The path

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getAlias

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

The alias of the toolbox, used when referencing a tool: name_alias.

Returns:

The alias

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getToolNames

IEnumGPToolName getToolNames()
                             throws java.io.IOException,
                                    AutomationException

An enumeration of all the geoprocessing tool name objects contained within the toolbox.

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTools

IEnumGPTool getTools()
                     throws java.io.IOException,
                            AutomationException

An enumeration of all the geoprocessing tools contained within the toolbox.

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

openTool

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

Returns a specific tool (by name) within the toolbox.

Parameters:

name - The name (in)

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.

isDeleted

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

Indicates if the toolbox has been deleted.

Returns:

The deleted

Throws:

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

AutomationException - If the ArcObject component throws an exception.

canCreateTool

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

Returns whether or not a new tool can be created in the toolbox.

Returns:

The canCreateTool

Throws:

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

AutomationException - If the ArcObject component throws an exception.

createTool

IGPTool createTool(int type,
                   java.lang.String name,
                   java.lang.String displayName,
                   java.lang.String description,
                   java.lang.String toolCategory,
                   IGPToolExtension toolExtension)
                   throws java.io.IOException,
                          AutomationException

Creates a new tool in the toolbox.

Parameters:

type - A com.esri.arcgis.geoprocessing.esriGPToolType constant (in)

name - The name (in)

displayName - The displayName (in)

description - The description (in)

toolCategory - The toolCategory (in)

toolExtension - A reference to a com.esri.arcgis.geoprocessing.IGPToolExtension (in)

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.

alterAlias

void alterAlias(java.lang.String newAlias)
                throws java.io.IOException,
                       AutomationException

Changes the alias of the toolbox.

Parameters:

newAlias - The newAlias (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

The name of the (CHM) file containing help information for this toolbox.

Returns:

The file

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 toolbox.

Returns:

The context

Throws:

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

AutomationException - If the ArcObject component throws an exception.

alterHelpInfo

void alterHelpInfo(java.lang.String file,
                   int context)
                   throws java.io.IOException,
                          AutomationException

Sets the help (CHM) file and help context identifier containing help for this toolbox.

Parameters:

file - The file (in)

context - The context (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.