com.esri.arcgis.geoprocessing
Class ToolboxWorkspaceExtension

java.lang.Object
  com.esri.arcgis.geoprocessing.ToolboxWorkspaceExtension

All Implemented Interfaces:

IWorkspaceExtension, IWorkspaceExtensionControl, IToolboxWorkspaceExtension, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class ToolboxWorkspaceExtension
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IWorkspaceExtension, IWorkspaceExtensionControl, IToolboxWorkspaceExtension

Workspace extension to support toolboxes in a geodatabase.

Product Availability

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

Supported Platforms

Windows

See Also:

Serialized Form

Constructor Summary

ToolboxWorkspaceExtension()
Constructs a ToolboxWorkspaceExtension using ArcGIS Engine.

ToolboxWorkspaceExtension(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
ToolboxWorkspaceExtension theToolboxWorkspaceExtension = (ToolboxWorkspaceExtension) obj;

Method Summary

boolean	equals(Object o) Compare this object with another
static String	getClsid() getClsid.
IEnumBSTR	getDataDictionaryTableNames() Any data dictionary tables that should not be exposed to browsers and should not participate in edit sessions.
IUID	getGUID() The GUID that identifies this Workspace Extension.
String	getName() The Name for this Workspace Extension.
IEnumBSTR	getPrivateDatasetNames(int dtype) The private datasets that should not be exposed to browsers.
int	hashCode() the hashcode for this object
void	init(IWorkspaceHelper pWorkspaceHelper) Initializes the extension, passing in a reference to its workspace helper.
void	shutdown() Informs the extension that its workspace helper (and workspace) are going away.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

ToolboxWorkspaceExtension

public ToolboxWorkspaceExtension()
                          throws IOException,
                                 UnknownHostException

Constructs a ToolboxWorkspaceExtension using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

ToolboxWorkspaceExtension

public ToolboxWorkspaceExtension(Object obj)
                          throws IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
ToolboxWorkspaceExtension theToolboxWorkspaceExtension = (ToolboxWorkspaceExtension) obj;

Construct a ToolboxWorkspaceExtension using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to ToolboxWorkspaceExtension.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

getName

public String getName()
               throws IOException,
                      AutomationException

The Name for this Workspace Extension.

Remarks

The Name property is the name of the extension.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getName in interface IWorkspaceExtension

Returns:

The pName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getGUID

public IUID getGUID()
             throws IOException,
                    AutomationException

The GUID that identifies this Workspace Extension.

Remarks

The GUID property returns the well-known GUID for the extension and is guaranteed to be unique.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getGUID in interface IWorkspaceExtension

Returns:

A reference to a com.esri.arcgis.system.IUID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPrivateDatasetNames

public IEnumBSTR getPrivateDatasetNames(int dtype)
                                 throws IOException,
                                        AutomationException

The private datasets that should not be exposed to browsers.

Product Availability

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

Specified by:

getPrivateDatasetNames in interface IWorkspaceExtension

Parameters:

dtype - A com.esri.arcgis.geodatabase.esriDatasetType constant (in)

Returns:

A reference to a com.esri.arcgis.system.IEnumBSTR

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDataDictionaryTableNames

public IEnumBSTR getDataDictionaryTableNames()
                                      throws IOException,
                                             AutomationException

Any data dictionary tables that should not be exposed to browsers and should not participate in edit sessions.

Remarks

The PrivateDatasetNames and DataDictionaryNames properties return the names of tables and datasets that are private to the extension and will not be exposed by the workspace to browsing clients. Since they return an EnumBSTR object that is not cocreatable, you must create your own object that implements IEnumBSTR.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getDataDictionaryTableNames in interface IWorkspaceExtension

Returns:

A reference to a com.esri.arcgis.system.IEnumBSTR

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

init

public void init(IWorkspaceHelper pWorkspaceHelper)
          throws IOException,
                 AutomationException

Initializes the extension, passing in a reference to its workspace helper.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

init in interface IWorkspaceExtensionControl

Parameters:

pWorkspaceHelper - A reference to a com.esri.arcgis.geodatabase.IWorkspaceHelper (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

shutdown

public void shutdown()
              throws IOException,
                     AutomationException

Informs the extension that its workspace helper (and workspace) are going away.

Remarks

The Shutdown method informs the workspace extension that the workspace has been released by all clients and is about to go away. In response, the workspace extension should release its reference on the workspace helper. Any subsequent calls by the application to the workspace extension should return an error.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

shutdown in interface IWorkspaceExtensionControl

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.