com.esri.arcgis.geodatabase
Class IWorkspaceExtensionControlProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.geodatabase.IWorkspaceExtensionControlProxy

All Implemented Interfaces:

IWorkspaceExtensionControl, Externalizable, Serializable

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

See Also:

Serialized Form

Field Summary

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

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, E

Constructor Summary

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

Method Summary

void	addListener(String iidStr, Object theListener, Object theSource)
void	init(IWorkspaceHelper pWorkspaceHelper) Initializes the extension, passing in a reference to its workspace helper.
void	readExternal(ObjectInput in)
void	removeListener(String iidStr, Object theListener)
void	shutdown() Informs the extension that its workspace helper (and workspace) are going away.
void	writeExternal(ObjectOutput out)

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, queryInterface, release, setNativeMode, setPropertyByName, toString, vtblInvoke

Methods inherited from class java.lang.Object

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

Constructor Detail

IWorkspaceExtensionControlProxy

public IWorkspaceExtensionControlProxy()

IWorkspaceExtensionControlProxy

public IWorkspaceExtensionControlProxy(Object obj)
                                throws IOException

Throws:

IOException

IWorkspaceExtensionControlProxy

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

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.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Overrides:

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

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Overrides:

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

Throws:

IOException

ClassNotFoundException