Package com.microstrategy.web.objects.admin

Interface ObjectLockSource

All Known Implementing Classes:

ObjectLockSourceImpl

public interface ObjectLockSource

The interface ObjectLockSource administrates object locks. It provides operations to lock and unlock objects as well as query locks on any object.

Since:

MicroStrategy Web 9.0.0

Method Summary

Modifier and Type	Method	Description
void	lockObject(java.lang.String objectID, int objectType, int lockFlag, java.lang.String lockComments)	Locks a first class object.
ObjectLock	queryObjectLock(java.lang.String objectID, int objectType, int queryFlag)	Queries the lock on an object.
void	unlockObject(java.lang.String objectID, int objectType, int lockFlag)	Unlocks a first class object.

Method Detail

lockObject

void lockObject(java.lang.String objectID,
                int objectType,
                int lockFlag,
                java.lang.String lockComments)
         throws WebObjectsAdminException

Locks a first class object.

Parameters:

objectID - the DSSID of an object.

objectType - the object type, a value from EnumDSSXMLObjectTypes

lockFlag - the lock flag, a value from EnumDSSXMLObjectLockFlags

lockComments - the comments put on the lock of an object.

Throws:

WebObjectsAdminException - thrown if there is any error occurred.

unlockObject

void unlockObject(java.lang.String objectID,
                  int objectType,
                  int lockFlag)
           throws WebObjectsAdminException

Unlocks a first class object.

Parameters:

objectID - the DSSID of an object.

objectType - the object type, a value from EnumDSSXMLObjectTypes

lockFlag - the lock flag, a value from EnumDSSXMLObjectLockFlags

Throws:

WebObjectsAdminException - thrown if there is any error occurred.

queryObjectLock

ObjectLock queryObjectLock(java.lang.String objectID,
                           int objectType,
                           int queryFlag)
                    throws WebObjectsAdminException

Queries the lock on an object.

Parameters:

objectID - the DSSID of an object.

objectType - the object type, a value from EnumDSSXMLObjectTypes

queryFlag - a flag indicates what lock information to retrieve, a value from EnumDSSXMLLockQuery

Throws:

WebObjectsAdminException