Summary: Methods | [Expand All]
public interface

ObjectLockSource

com.microstrategy.web.objects.admin.ObjectLockSource
Known Indirect Subclasses

Class Overview

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

Summary

Public Methods
abstract void lockObject(String objectID, int objectType, int lockFlag, String lockComments)
Locks a first class object.
abstract ObjectLock queryObjectLock(String objectID, int objectType, int queryFlag)
Queries the lock on an object.
abstract void unlockObject(String objectID, int objectType, int lockFlag)
Unlocks a first class object.

Public Methods

public abstract void lockObject (String objectID, int objectType, int lockFlag, String lockComments)

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.

public abstract ObjectLock queryObjectLock (String objectID, int objectType, int queryFlag)

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

public abstract void unlockObject (String objectID, int objectType, int lockFlag)

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.