oracle.ifs.beans
Class SystemLockObject

java.lang.Object
  |
  +--oracle.ifs.beans.LibraryObject
        |
        +--oracle.ifs.beans.TieLibraryObject
              |
              +--oracle.ifs.beans.SystemObject
                    |
                    +--oracle.ifs.beans.TieSystemObject
                          |
                          +--oracle.ifs.beans.LockObject
                                |
                                +--oracle.ifs.beans.TieLockObject
                                      |
                                      +--oracle.ifs.beans.SystemLockObject

All Implemented Interfaces:

IfsEventHandler, LibraryObjectInterface, SystemObjectInterface, Traceable

Direct Known Subclasses:

TieSystemLockObject

public class SystemLockObject

extends TieLockObject

SystemLockObject subclass. This subclass is meant to encapsulate a system lock object. These lock objects are unique by name and can only be created by administrators. They can be queried by name through its collection on LibrarySession.

Out of the box, the repository will provide two instances of this class "SystemHardLock" and "SystemSoftLock" to represent a hard and soft lock respectively. For the details on HardLock and SoftLock state, refer to the documentation for the LockObject class. These objects can be queried by name from the domain property bundle. The names of the properties are defined as static constants in LibraryConstants.java.

To obtain a hard or soft lock on a PublicObject, use the po.lock(LockObject lo) method passing in the SystemSoftLock or SystemHardLock object as a parameter. Since this is a systemobject, it can only be updated and created by Administrators.

See Also:

LockObject

Field Summary

static java.lang.String	CLASS_NAME This class name for this class.
static java.lang.String	NAME_ATTRIBUTE A system-set attribute used to ensure each SystemLockObject has a unique name.

Fields inherited from class oracle.ifs.beans.LockObject

LOCKEDFORSESSION_ATTRIBUTE, LOCKHOLDER_ATTRIBUTE, LOCKSTATE_ATTRIBUTE, LOCKSTATE_HARDLOCK, LOCKSTATE_SESSIONLOCK, LOCKSTATE_SOFTLOCK, LOCKSTATE_USERLOCK, LOCKTIMEOUT_ATTRIBUTE

Fields inherited from class oracle.ifs.beans.SystemObject

ACTIVE_ATTRIBUTE, POLICYBUNDLE_ATTRIBUTE, PROPERTYBUNDLE_ATTRIBUTE

Method Summary

java.lang.String	getName() Returns the name of this object
void	setLockHolder(DirectoryUser du) set the lockholder.

Methods inherited from class oracle.ifs.beans.LockObject

getLockHolder, getLockState, getLockStateLabel, getLockTimeOut, getReferringPublicObjects, getReferringPublicObjects, isLockedForSession, isLockedForSessionByCurrentSession, isShared, setLockState, setLockTimeOut, toLockStateLabel, toLockStateLabel, toLockStateLabel

Methods inherited from class oracle.ifs.beans.SystemObject

getPolicyBundle, getPropertyBundle, isActive, putPolicy, putProperty, putProperty, removeAllPolicies, removeAllProperties, removePolicy, removePolicy, removeProperty, setActive, setPolicyBundle, setPropertyBundle

Methods inherited from class oracle.ifs.beans.LibraryObject

equals, free, free, getAttribute, getAttributeByUpperCaseName, getAttributes, getAttributesByUpperCaseNames, getClassId, getClassObject, getDefinition, getId, getLabel, getSession, handleEvent, hasNameAttribute, invokeServerMethod, isInstanceOf, isTraced, lookupInstanceLabel, postEvent, postEvent, renderAsReader, renderAsStream, setAttribute, setAttribute, setAttributes, setAttributes, setName, toString, trace, update

Methods inherited from interface oracle.ifs.common.LibraryObjectInterface

getId

Methods inherited from interface oracle.ifs.common.Traceable

getTraceLogger, isTraced, trace

Field Detail

CLASS_NAME

public static final java.lang.String CLASS_NAME

This class name for this class. Useful for methods that take a class name argument.

NAME_ATTRIBUTE

public static final java.lang.String NAME_ATTRIBUTE

A system-set attribute used to ensure each SystemLockObject has a unique name.

Method Detail

getName

public java.lang.String getName()
                         throws IfsException

Returns the name of this object

Overrides:

getName in class LibraryObject

Returns:

The name of the SystemLock object

Throws:

IfsException - if operation fails.

setLockHolder

public void setLockHolder(DirectoryUser du)
                   throws IfsException

set the lockholder. Valid only for SystemLockObject that is in UserLock state.

Parameters:

Directoryuser - the lockholder

Throws:

IfsException - if the operation fails