com.esri.arcgis.geodatabase
Interface IWorkspaceFactoryLockControl

All Superinterfaces:

Serializable

All Known Implementing Classes:

IWorkspaceFactoryLockControlProxy

public interface IWorkspaceFactoryLockControl
extends Serializable

Manages Geodatabase Locking

Remarks

The IWorkspaceFactoryLockControl API must be used with extreme caution. Disabling schema locks can have adverse affects on all connected users. The disabling of schema locks not only prevents that workspace from establishing schema locks on an objects schema; it will also ignore any existing schema locks established by other processes.

This API is exposed at the workspace factory and allows for the Enabling and Disabling of schema locking on any workspace instantiated by the workspace factory. By default, schema locking is enabled on any workspace instantiated from a workspace factory.

Product Availability

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

Method Summary

void	disableSchemaLocking() All workspaces created and managed by the factory will have schema locking disabled.
void	enableSchemaLocking() All workspaces created and managed by the factory will have schema locking enabled.
boolean	isSchemaLockingEnabled() Returns true if this factory has schema locking enabled.

Method Detail

isSchemaLockingEnabled

boolean isSchemaLockingEnabled()
                               throws IOException,
                                      AutomationException

Returns true if this factory has schema locking enabled.

Remarks

The read-only SchemaLockingEnabled property allows a caller to determine if the factory currently has schema locking enabled or disabled.

Product Availability

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

Returns:

The isSchemaLockingEnabled

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

enableSchemaLocking

void enableSchemaLocking()
                         throws IOException,
                                AutomationException

All workspaces created and managed by the factory will have schema locking enabled.

Remarks

The EnableSchemaLocking method is only needed if there is a need to turn schema locking “back on” after having called DisableSchemaLocking.

Product Availability

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

disableSchemaLocking

void disableSchemaLocking()
                          throws IOException,
                                 AutomationException

All workspaces created and managed by the factory will have schema locking disabled.

Remarks

The DisableSchemaLocking method will first attempt to release any existing schema locks for this process. It will also set a state of the IWorkspaceFactory that informs all workspaces instantiated by that factory to disable schema locking.

It is important to understand that when schema locking is disabled on a workspace, it doesn’t invalidate the schema lock API. The methods related to this API such as ISchemaLock.ChangeSchemaLock() will not result in the acquiring of a schema lock on the desired object.

Product Availability

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.