com.esri.arcgis.geoprocessing
Class IGPToolboxProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.geoprocessing.IGPToolboxProxy

All Implemented Interfaces:

IGPToolbox, Externalizable, Serializable

public class IGPToolboxProxy
extends com.esri.arcgis.interop.Dispatch
implements IGPToolbox, Serializable

Provides access to methods on the toolbox object.

Superseded By

IGPToolbox2

Remarks

A toolbox is a persistent entity that can contain toolsets and geoprocessing tools. It takes the form of a .tbx file on disk or a table in a geodatabase.

In a geodatabase, each toolbox must have a unique name. Note that this is different from a file system model, where two folders can contain toolboxes with the same local name within the folder.

When To Use

The IGPToolbox interface provides access to methods for creating new tools, opening tools, checking existence of tools, as well discovering the names of tools in a given toolbox.

Product Availability

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

See Also:

Serialized Form

Field Summary

boolean

noncastable

Fields inherited from class com.esri.arcgis.interop.Dispatch

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef

Constructor Summary

	IGPToolboxProxy()
	IGPToolboxProxy(Object obj)
protected	IGPToolboxProxy(Object obj, String iid)

Method Summary

void	addListener(String iidStr, Object theListener, Object theSource)
void	alterAlias(String newAlias) Changes the alias of the toolbox.
void	alterHelpInfo(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, String name, String displayName, String description, String toolCategory, IGPToolExtension toolExtension) Creates a new tool in the toolbox.
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.
String	getHelpFile() The name of the (CHM) file containing help information for this toolbox.
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(String name) Returns a specific tool (by name) within the toolbox.
void	removeListener(String iidStr, Object theListener)

Methods inherited from class com.esri.arcgis.interop.Dispatch

bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, optimizedVtblInvoke, queryInterface, readExternal, release, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

noncastable

public boolean noncastable

Constructor Detail

IGPToolboxProxy

public IGPToolboxProxy()

IGPToolboxProxy

public IGPToolboxProxy(Object obj)
                throws IOException

Throws:

IOException

IGPToolboxProxy

protected IGPToolboxProxy(Object obj,
                          String iid)
                   throws IOException

Throws:

IOException

Method Detail

addListener

public void addListener(String iidStr,
                        Object theListener,
                        Object theSource)
                 throws IOException

Overrides:

addListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

removeListener

public void removeListener(String iidStr,
                           Object theListener)
                    throws IOException

Overrides:

removeListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

getPathName

public String getPathName()
                   throws IOException,
                          AutomationException

The path name to the toolbox.

Product Availability

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

Supported Platforms

Windows

Specified by:

getPathName in interface IGPToolbox

Returns:

The path

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAlias

public String getAlias()
                throws IOException,
                       AutomationException

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

Product Availability

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

Supported Platforms

Windows

Specified by:

getAlias in interface IGPToolbox

Returns:

The alias

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getToolNames

public IEnumGPToolName getToolNames()
                             throws IOException,
                                    AutomationException

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

Product Availability

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

Supported Platforms

Windows

Specified by:

getToolNames in interface IGPToolbox

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTools

public IEnumGPTool getTools()
                     throws IOException,
                            AutomationException

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

Product Availability

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

Supported Platforms

Windows

Specified by:

getTools in interface IGPToolbox

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

openTool

public IGPTool openTool(String name)
                 throws IOException,
                        AutomationException

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

Product Availability

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

Supported Platforms

Windows

Specified by:

openTool in interface IGPToolbox

Parameters:

name - The name (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDeleted

public boolean isDeleted()
                  throws IOException,
                         AutomationException

Indicates if the toolbox has been deleted.

Product Availability

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

Supported Platforms

Windows

Specified by:

isDeleted in interface IGPToolbox

Returns:

The deleted

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

canCreateTool

public boolean canCreateTool()
                      throws IOException,
                             AutomationException

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

Product Availability

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

Supported Platforms

Windows

Specified by:

canCreateTool in interface IGPToolbox

Returns:

The canCreateTool

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createTool

public IGPTool createTool(int type,
                          String name,
                          String displayName,
                          String description,
                          String toolCategory,
                          IGPToolExtension toolExtension)
                   throws IOException,
                          AutomationException

Creates a new tool in the toolbox.

Product Availability

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

Supported Platforms

Windows

Specified by:

createTool in interface IGPToolbox

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:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

alterAlias

public void alterAlias(String newAlias)
                throws IOException,
                       AutomationException

Changes the alias of the toolbox.

Product Availability

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

Supported Platforms

Windows

Specified by:

alterAlias in interface IGPToolbox

Parameters:

newAlias - The newAlias (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHelpFile

public String getHelpFile()
                   throws IOException,
                          AutomationException

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

Product Availability

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

Supported Platforms

Windows

Specified by:

getHelpFile in interface IGPToolbox

Returns:

The file

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHelpContext

public int getHelpContext()
                   throws IOException,
                          AutomationException

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

Product Availability

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

Supported Platforms

Windows

Specified by:

getHelpContext in interface IGPToolbox

Returns:

The context

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

alterHelpInfo

public void alterHelpInfo(String file,
                          int context)
                   throws IOException,
                          AutomationException

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

Product Availability

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

Supported Platforms

Windows

Specified by:

alterHelpInfo in interface IGPToolbox

Parameters:

file - The file (in)

context - The context (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.