Package mks.ci.server.engine

Class LockTriggerHandler.ScriptUnlockResultBean

java.lang.Object

mks.frame.triggers.ScriptExposableBaseBean

mks.frame.triggers.beans.ScriptBaseBean

mks.ci.server.engine.LocalTriggerManager.ScriptIMBaseBean

mks.ci.server.engine.LockTriggerHandler.ScriptCommonBaseBean

mks.ci.server.engine.LockTriggerHandler.ScriptUnlockBaseBean

mks.ci.server.engine.LockTriggerHandler.ScriptUnlockResultBean

All Implemented Interfaces:

mks.frame.triggers.ScriptExposableBean

Enclosing class:

LockTriggerHandler

public static class LockTriggerHandler.ScriptUnlockResultBean
extends LockTriggerHandler.ScriptUnlockBaseBean
implements mks.frame.triggers.ScriptExposableBean

The Unlock Result Bean (imUnlockResultBean)

This bean is available when the unlock post trigger is fired.

The post unlock trigger is fired after the unlock operation has committed. At this point, it has completed. Both this bean and the imUnlockArgsBean LockTriggerHandler.ScriptUnlockArgsBean are available.

Constructor Summary

Constructors

Constructor	Description
ScriptUnlockResultBean(java.util.List<java.lang.Integer> docIDs, int unlockUserID, java.util.Collection<mks.ci.common.DocumentLock> lockInfo, java.sql.Connection c)

Method Summary

Modifier and Type	Method	Description
java.lang.String	getExposedName()	The name of this bean: imUnlockResultBean
LocalTriggerManager.ScriptPrincipalBean	getLockPrincipalBean(int documentID)	Returns the ScriptUserBean, ScriptGroupBean, or ScriptDynamicGroupBean, depending on whether it was a group or user lock that has been unlocked.
boolean	wasGroupLock(int documentID)	Returns True if the unlocked lock was a group lock
boolean	wasUserLock(int documentID)	Returns True if the unlocked lock was a user lock

Methods inherited from class mks.ci.server.engine.LockTriggerHandler.ScriptUnlockBaseBean

getUnlockUserBean

Methods inherited from class mks.ci.server.engine.LockTriggerHandler.ScriptCommonBaseBean

getDocumentIDs

Methods inherited from class mks.ci.server.engine.LocalTriggerManager.ScriptIMBaseBean

getCurrentDatabaseTime, getCurrentDatabaseTime, getCurrentUser, getServerBean, getUserID, isParallelProcessingEnabled

Methods inherited from class mks.frame.triggers.beans.ScriptBaseBean

getEnvironmentBean, setEnvironmentBean

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface mks.frame.triggers.ScriptExposableBean

getEnvironmentBean, setEnvironmentBean

Constructor Detail

ScriptUnlockResultBean

public ScriptUnlockResultBean(java.util.List<java.lang.Integer> docIDs,
                              int unlockUserID,
                              java.util.Collection<mks.ci.common.DocumentLock> lockInfo,
                              java.sql.Connection c)

Method Detail

getExposedName

public java.lang.String getExposedName()

The name of this bean: imUnlockResultBean

Specified by:

getExposedName in interface mks.frame.triggers.ScriptExposableBean

Specified by:

getExposedName in class ScriptBaseBean

Returns:

the bean name: siMemberBean.

wasGroupLock

public boolean wasGroupLock(int documentID)

Returns True if the unlocked lock was a group lock

Parameters:

documentID - The id of the document that had the lock

getLockPrincipalBean

public LocalTriggerManager.ScriptPrincipalBean getLockPrincipalBean(int documentID)

Returns the ScriptUserBean, ScriptGroupBean, or ScriptDynamicGroupBean, depending on whether it was a group or user lock that has been unlocked.

Parameters:

documentID - The id of the document that had the lock

wasUserLock

public boolean wasUserLock(int documentID)

Returns True if the unlocked lock was a user lock

Parameters:

documentID - The id of the document that had the lock