com.esri.arcgis.geodatabase
Interface ILockInfo

All Superinterfaces:

Serializable

All Known Implementing Classes:

ILockInfoProxy

public interface ILockInfo
extends Serializable

Provides access to members that supply lock information.

Description

The ILockInfo interface provides the ability to detect what current users have version locks and if the lock is shared or exclusive. Locks imply that the users are currently editing the version or currently reconciling the version. This information can be used to determine if the version is available for editing, to be reconciled or to be reconciled against.

Product Availability

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

Method Summary

int	getLockType() The type of lock the user acquired.
String	getUserName() The name of the user that acquired the lock.

Method Detail

getUserName

String getUserName()
                   throws IOException,
                          AutomationException

The name of the user that acquired the lock.

Remarks

The UserName method returns the user name who is currently editing or reconciling the version.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The user

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLockType

int getLockType()
                throws IOException,
                       AutomationException

The type of lock the user acquired.

Remarks

The LockType method returns the type of lock the current user has on the version. Shared locks are acquired upon start editing and released at stop editing. Shared locks are promoted to Exclusive locks during reconcile or when a version is being reconciled against.

The Exclusive lock prevents multiple reconciliations against any one version simultaneously. This will prevent unnecessary reconciles, in the case where the version is reconciled and the target version is modified. Which then forces a second reconciliation and can waste server/client resources.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

A com.esri.arcgis.geodatabase.esriLockType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.