com.esri.arcgis.geodatabase
Interface IWorkspaceExtensionControl

All Superinterfaces:
Serializable
All Known Implementing Classes:
AddressLocatorWorkspaceExtension, CadastralWorkspaceDatasetExtension, IWorkspaceExtensionControlProxy, NetworkDatasetWorkspaceExtension, RepresentationWorkspaceExtension, TerrainWorkspaceExtension, ToolboxWorkspaceExtension, TopologyWorkspaceExtension, WorkspaceExtension

public interface IWorkspaceExtensionControl
extends Serializable

Provides access to members that manage the life of a workspace extension.

Remarks

IWorkspaceExtensionControl is a mandatory interface that must be supported by all workspace extensions. This interface is used by the workspace to manage the lifetime of the workspace extension. The workspace cocreates the workspace extension and calls the Init method handing it back a reference to the workspace via the workspace helper argument. The workspace helper implements a weak reference on the workspace. The extension can keep a strong reference on the workspace helper (for example, in a member variable) but should not keep a strong reference on the workspace. Extensions should get the workspace from the workspace helper in order to make any method calls on the workspace and release the reference after making the method calls.

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.

The IWorkspaceExtensionControl interface does not need to be considered by developers working with network datasets.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux


Method Summary
 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.
 

Method Detail

init

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

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

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

Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.