com.esri.arcgis.geoprocessing
Class IToolboxWorkspaceProxy

java.lang.Object
  extended by com.esri.arcgis.interop.Dispatch
      extended by com.esri.arcgis.geoprocessing.IToolboxWorkspaceProxy
All Implemented Interfaces:
IToolboxWorkspace, Externalizable, Serializable

public class IToolboxWorkspaceProxy
extends com.esri.arcgis.interop.Dispatch
implements IToolboxWorkspace, 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.

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
  IToolboxWorkspaceProxy()
           
  IToolboxWorkspaceProxy(Object obj)
           
protected IToolboxWorkspaceProxy(Object obj, String iid)
           
 
Method Summary
 void addListener(String iidStr, Object theListener, Object theSource)
           
 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.
 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

IToolboxWorkspaceProxy

public IToolboxWorkspaceProxy()

IToolboxWorkspaceProxy

public IToolboxWorkspaceProxy(Object obj)
                       throws IOException
Throws:
IOException

IToolboxWorkspaceProxy

protected IToolboxWorkspaceProxy(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

getToolboxNames

public 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

Specified by:
getToolboxNames in interface IToolboxWorkspace
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

public 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

Specified by:
getToolboxes in interface IToolboxWorkspace
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

public 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

Specified by:
openToolbox in interface IToolboxWorkspace
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

public 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

Specified by:
createToolbox in interface IToolboxWorkspace
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

public 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

Specified by:
deleteToolbox in interface IToolboxWorkspace
Parameters:
name - The name (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.