com.plumtree.server
Interface IPTLockManager

All Superinterfaces:

IPTUnknown

public interface IPTLockManager
extends IPTUnknown

Used to query for locked Plumtree objects, unlock locked objects, and clear expired object locks.

Author:

Joseph Chen

Method Summary

void	ClearAllExpiredLocks() Clears all expired locks.
IPTQueryResult	QueryForLockedObjectClasses() Query for locked object classes.
IPTQueryResult	QueryLockedObjects(int classID) Query each class for locked objects.
IPTQueryResult	QuerySingleObject(int classID, int objectID) Query for the status of a single object.
void	UnlockObject(int classID, int objectID) Unlock an object.

Methods inherited from interface com.plumtree.server.IPTUnknown

GetInterfaces

Method Detail

QueryForLockedObjectClasses

IPTQueryResult QueryForLockedObjectClasses()

Query for locked object classes. Returns a unique list of class IDs where object locks exist.

Returns:

Query result of locked object classes.

QueryLockedObjects

IPTQueryResult QueryLockedObjects(int classID)

Query each class for locked objects.

Query result contains following PropID's: PT_PROPID_OBJECTID, PT_PROPID_CLASSID, PT_PROPID_NAME, PT_PROPID_OBJLOCK_LOCKINGUSERID, PT_PROPID_OBJLOCK_FROMMACHINENAME, PT_PROPID_OBJLOCK_ACQUIREDAT, PT_PROPID_OBJLOCK_EXPIRESAT.

Parameters:

classID - Class ID (from PT_CLASSIDS)

Returns:

Query result of locked objects.

UnlockObject

void UnlockObject(int classID,
                  int objectID)

Unlock an object.

Parameters:

classID - Class ID (from PT_CLASSIDS)

objectID - Object ID of object

ClearAllExpiredLocks

void ClearAllExpiredLocks()

Clears all expired locks. By default, object locks are held for 24 hours.

QuerySingleObject

IPTQueryResult QuerySingleObject(int classID,
                                 int objectID)

Query for the status of a single object.

Query result contains following PropID's: PT_PROPID_OBJECTID, PT_PROPID_CLASSID, PT_PROPID_NAME, PT_PROPID_OBJLOCK_LOCKINGUSERID, PT_PROPID_OBJLOCK_FROMMACHINENAME, PT_PROPID_OBJLOCK_ACQUIREDAT, PT_PROPID_OBJLOCK_EXPIRESAT.

Parameters:

classID - Class ID (from PT_CLASSIDS)

objectID - Object ID of object

Returns:

Query result with 0 rows if unlocked or 1 row if locked.