com.esri.arcgis.datasourcesGDB
Interface IDatabaseLockInfo

All Superinterfaces:

Serializable

public interface IDatabaseLockInfo
extends Serializable

Infomation about database locks.

Remarks

An IDatabaseLockInfo object is returned from the IDatabaseLocksInfo.get_AllLocks enumeration of locks (IEnumDatabaseLockInfo). This interface provides information about the individual locks:

- IsOwnLock indicates if the lock was created by the connection made by the user.

- LockMode returns a value from the esriSdeLockMode enumeration:

• esriSdeLockMode.esriLockModeExclusive
• esriSdeLockMode.esriLockModeShared

- LockOwner returns the user name associated with the connection that created the lock as a string.

- LockTime returns the database time the lock was created.

- LockType returns a value from the esriSdeLockType enumeration:

• esriSdeLockType.esriLockTypeSchema
• esriSdeLockType.esriLockTypeState
• esriSdeLockType.esriLockTypeVersion

- ObjectID returns the lock identifier for its LockType.

- ObjectName returns the name of the object being locked.

- DatasetType returns the type of dataset locked as a value from the esriDatasetType enumeration. This property is only supported for the LockType of esriSdeLockType.esriLockTypeSchema.

Product Availability

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

Method Summary

int	getDatasetType() The type of the locked dataset, if it is a dataset.
int	getLockMode() The mode of the lock.
String	getLockOwner() The user that owns the lock.
Object	getLockTime() The time when the lock was acquired.
int	getLockType() The type of lock.
long	getObjectID() The ID of the locked object.
String	getObjectName() The name of the locked object.
int	getSessionID() The session that owns the lock.
boolean	isOwnLock() Is the lock from the current connection.

Method Detail

getSessionID

int getSessionID()
                 throws IOException,
                        AutomationException

The session that owns the lock.

Product Availability

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

Returns:

The sessionID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLockOwner

String getLockOwner()
                    throws IOException,
                           AutomationException

The user that owns the lock.

Product Availability

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

Returns:

The owner

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLockMode

int getLockMode()
                throws IOException,
                       AutomationException

The mode of the lock.

Product Availability

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

Returns:

A com.esri.arcgis.datasourcesGDB.esriSdeLockMode constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLockTime

Object getLockTime()
                   throws IOException,
                          AutomationException

The time when the lock was acquired.

Product Availability

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

Returns:

A Variant

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.

Product Availability

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

Returns:

A com.esri.arcgis.datasourcesGDB.esriSdeLockType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getObjectID

long getObjectID()
                 throws IOException,
                        AutomationException

The ID of the locked object.

Product Availability

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

Returns:

Signed 64-bit int

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getObjectName

String getObjectName()
                     throws IOException,
                            AutomationException

The name of the locked object.

Product Availability

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

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDatasetType

int getDatasetType()
                   throws IOException,
                          AutomationException

The type of the locked dataset, if it is a dataset.

Product Availability

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

Returns:

A com.esri.arcgis.geodatabase.esriDatasetType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isOwnLock

boolean isOwnLock()
                  throws IOException,
                         AutomationException

Is the lock from the current connection.

Product Availability

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

Returns:

The isOwnLock

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.