com.esri.arcgis.geoprocessing
Interface IToolboxWorkspace

All Superinterfaces:

Serializable

All Known Implementing Classes:

IToolboxWorkspaceProxy

public interface IToolboxWorkspace
extends Serializable

Provides access to methods on the toolbox workspace object.

Remarks

A Workspace is a container of spatial and nonspatial datasets such as feature classes, raster datasets, tables and toolboxes. It provides methods to instantiate existing datasets and to create new datasets. Workspaces are classified into types specified by the esriWorkspaceType enumerator: esriFileSystemWorksapce, esriLocalDatabaseWorkspace, and esriRemoteDatabaseWorkspace.

A toolbox workspace can be either an esriFileSystemWorkspace, an esriLocalDatabaseWorkspace, or an esriRemoteDatabaseWorkspace. Toolboxes can exist in a folder, a personal geodatabase, a file geodatabase, or an enterprise geodatabase.

See also IWorkspace.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Method Summary

IGPToolbox	createToolbox(String name, String alias) Creates a new toolbox in the workspace.
void	deleteToolbox(String name) Deletes a toolbox from the workspace.
IEnumGPToolbox	getToolboxes() An enumeration of toolbox objects contained in the workspace.
IEnumGPToolboxName	getToolboxNames() An enumeration of toolbox name objects contained in the workspace.
IGPToolbox	openToolbox(String name) Opens an existing toolbox in the workspace.

Method Detail

getToolboxNames

IEnumGPToolboxName getToolboxNames()
                                   throws IOException,
                                          AutomationException

An enumeration of toolbox name objects contained in the workspace.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getToolboxes

IEnumGPToolbox getToolboxes()
                            throws IOException,
                                   AutomationException

An enumeration of toolbox objects contained in the workspace.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

openToolbox

IGPToolbox openToolbox(String name)
                       throws IOException,
                              AutomationException

Opens an existing toolbox in the workspace.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows

Parameters:

name - The name (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createToolbox

IGPToolbox createToolbox(String name,
                         String alias)
                         throws IOException,
                                AutomationException

Creates a new toolbox in the workspace.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows

Parameters:

name - The name (in)

alias - The alias (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deleteToolbox

void deleteToolbox(String name)
                   throws IOException,
                          AutomationException

Deletes a toolbox from the workspace.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.