com.esri.arcgis.geoprocessing
Class IGPToolbox2Proxy

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

All Implemented Interfaces:

IGPToolbox2, Externalizable, Serializable

public class IGPToolbox2Proxy
extends com.esri.arcgis.interop.Dispatch
implements IGPToolbox2, Serializable

Provides access to methods on the toolbox object.

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

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

Method Summary

void	addListener(String iidStr, Object theListener, Object theSource)
void	alterAlias(String newAlias) Alters the alias of the toolbox.
void	alterDisplayName(String newDisplayName) Modifies the display name property of the toolbox.
void	alterHelpInfo(String file, int context) Sets the help (CHM) file and help context identifier containing help for this toolbox.
boolean	canAlterDisplayName() Returns whether or not the display name property can be modified.
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.
String	getDisplayName() The display name of the toolbox.
int	getHelpContext() The context identifier of the topic within the help file for this toolbox.
String	getHelpFile() Name of the (CHM) file containing help information for this toolbox.
String	getPathName() The path name of 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

IGPToolbox2Proxy

public IGPToolbox2Proxy()

IGPToolbox2Proxy

public IGPToolbox2Proxy(Object obj)
                 throws IOException

Throws:

IOException

IGPToolbox2Proxy

protected IGPToolbox2Proxy(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 of the toolbox.

Product Availability

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

Specified by:

getPathName in interface IGPToolbox2

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.

Product Availability

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

Specified by:

getAlias in interface IGPToolbox2

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.

Specified by:

getToolNames in interface IGPToolbox2

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.

Specified by:

getTools in interface IGPToolbox2

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.

Specified by:

openTool in interface IGPToolbox2

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.

Specified by:

isDeleted in interface IGPToolbox2

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.

Specified by:

canCreateTool in interface IGPToolbox2

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.

Specified by:

createTool in interface IGPToolbox2

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

Alters the alias of the toolbox.

Product Availability

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

Specified by:

alterAlias in interface IGPToolbox2

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

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

Product Availability

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

Specified by:

getHelpFile in interface IGPToolbox2

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.

Specified by:

getHelpContext in interface IGPToolbox2

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.

Specified by:

alterHelpInfo in interface IGPToolbox2

Parameters:

file - The file (in)

context - The context (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDisplayName

public String getDisplayName()
                      throws IOException,
                             AutomationException

The display name of the toolbox.

Product Availability

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

Specified by:

getDisplayName in interface IGPToolbox2

Returns:

The displayName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

canAlterDisplayName

public boolean canAlterDisplayName()
                            throws IOException,
                                   AutomationException

Returns whether or not the display name property can be modified.

Product Availability

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

Specified by:

canAlterDisplayName in interface IGPToolbox2

Returns:

The canAlterDisplayName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

alterDisplayName

public void alterDisplayName(String newDisplayName)
                      throws IOException,
                             AutomationException

Modifies the display name property of the toolbox.

Product Availability

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

Specified by:

alterDisplayName in interface IGPToolbox2

Parameters:

newDisplayName - The newDisplayName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.