oracle.ifs.server
Class S_LockObject

java.lang.Object
  |
  +--oracle.ifs.server.S_LibraryObject
        |
        +--oracle.ifs.server.S_TieLibraryObject
              |
              +--oracle.ifs.server.S_SystemObject
                    |
                    +--oracle.ifs.server.S_TieSystemObject
                          |
                          +--oracle.ifs.server.S_LockObject

All Implemented Interfaces:

IfsEventHandler, LibraryObjectInterface, SystemObjectInterface, Traceable

Direct Known Subclasses:

S_TieLockObject

public class S_LockObject

extends S_TieSystemObject

S_LockObject is a server side representation of the iFS LOCKOBJECT class. It is meant to represent information associated with locks on a PublicObject

Method Summary

protected void	deriveDefinition(S_LibraryObjectDefinition def) Add to the S_LibraryObjectDefinition for this class.
protected void	extendedPreFree(OperationState opState, S_LibraryObjectDefinition def) operations to be performed before freeing an object.
protected void	extendedPreInsert(OperationState opState, S_LibraryObjectDefinition def) Performs pre-insert validation.
protected void	extendedPreUpdate(OperationState opState, S_LibraryObjectDefinition def) Update any system attributes appropriate for creating this object
boolean	isLockedForSession() Returns true if the LockState of this object is LOCKSTATE_SESSIONLOCK If the PublicObject that points to this LockObject has a session lock, this will return true.
boolean	isLockedForSessionByCurrentSession() Returns true if the PublicObject that refers to this LockObject has a session lock, and it is held by the invoking session.
protected boolean	isShared() Returns true if this LockObject is referenced by multiple PublicObjects
boolean	isUserLockedByCurrentSessionUser() Returns true if the LockState of this object is LOCKSTATE_USERLOCK and it is held by the currently logged in user of the current session.

Methods inherited from class oracle.ifs.server.S_LibraryObject

equals, extendedPostFree, extendedPostInsert, extendedPostUpdate, free, getAttribute, getAttributeByUpperCaseName, getClassId, getClassObject, getId, getSession, handleEvent, hasNameAttribute, isTraced, postEvent, postEvent, renderAsReader, renderAsStream, setAttribute, setAttribute, toString, trace, update

Methods inherited from interface oracle.ifs.common.LibraryObjectInterface

getId

Methods inherited from interface oracle.ifs.common.Traceable

getTraceLogger, isTraced, trace

Method Detail

deriveDefinition

protected void deriveDefinition(S_LibraryObjectDefinition def)
                         throws IfsException

Add to the S_LibraryObjectDefinition for this class. This is called by getDefinition() on S_LibraryObject. This must call super.deriveDefinition() before applying any class-specific changes to the S_LibraryObjectDefinition object.

Overrides:

deriveDefinition in class S_LibraryObject

Parameters:

def - the S_LibraryObjectDefinition that contains the definition of the target object.

Throws:

IfsException - if operation fails.

extendedPreInsert

protected void extendedPreInsert(OperationState opState,
                                 S_LibraryObjectDefinition def)
                          throws IfsException

Performs pre-insert validation.

Overrides:

extendedPreInsert in class S_SystemObject

Parameters:

opState - operation state

def - the definition of the InterMediaSource being created

Throws:

IfsException - if operation fails

extendedPreUpdate

protected void extendedPreUpdate(OperationState opState,
                                 S_LibraryObjectDefinition def)
                          throws IfsException

Update any system attributes appropriate for creating this object

Overrides:

extendedPreUpdate in class S_LibraryObject

Parameters:

the - operation state

def - current object definition to be updated with system attributes

Throws:

IfsException - if operation fails.

extendedPreFree

protected void extendedPreFree(OperationState opState,
                               S_LibraryObjectDefinition def)
                        throws IfsException

operations to be performed before freeing an object. This is overridden by classes that need to perform operations after successfully deleting the rows for the freed instance.

Overrides:

extendedPreFree in class S_LibraryObject

Parameters:

opState - current operation state

def - current object definition to be updated with system attributes

Throws:

IfsException - if operation fails.

isLockedForSession

public boolean isLockedForSession()
                           throws IfsException

Returns true if the LockState of this object is LOCKSTATE_SESSIONLOCK If the PublicObject that points to this LockObject has a session lock, this will return true.

Returns:

true if LockState is LOCKSTATE_SESSIONLOCK.

Throws:

IfsException - if operation fails. FIXME : why doesent this work off of the lockstate ?/

isLockedForSessionByCurrentSession

public boolean isLockedForSessionByCurrentSession()
                                           throws IfsException

Returns true if the PublicObject that refers to this LockObject has a session lock, and it is held by the invoking session. The LockState of this LockObject is LOCKSTATE_SESSIONLOCK

Returns:

true if there is a session lock state on this object, and it is held by the invoking session.

Throws:

IfsException - if operation fails.

isUserLockedByCurrentSessionUser

public boolean isUserLockedByCurrentSessionUser()
                                         throws IfsException

Returns true if the LockState of this object is LOCKSTATE_USERLOCK and it is held by the currently logged in user of the current session.

Returns:

true if there is a user lock held on this object, and it is held by the invoking session user.

Throws:

IfsException - if operation fails.

isShared

protected boolean isShared()
                    throws IfsException

Returns true if this LockObject is referenced by multiple PublicObjects

Parameters:

id - the lockObject

Returns:

true if the lockobject is referenced by multiple pos

Throws:

IfsException - if the operation fails