Package mks.si.brain.triggers.beans

Class ScriptLockRevisionArgumentsBean

  • All Implemented Interfaces:
    mks.frame.triggers.ScriptExposableBean
    public class ScriptLockRevisionArgumentsBean
extends ScriptBaseBean
implements mks.frame.triggers.ScriptExposableBean
    The class for arguments to a lock revision API call; this bean is available during a Member.lockRevision event and a Revision.lockRevision event.
    See Also:
    ScriptRevisionBean, ScriptMemberBean

    • Constructor Summary

      Constructors 
      Constructor Description
      ScriptLockRevisionArgumentsBean​(mks.si.brain.api.LocalMember localMember, mks.si.api.RevisionID revisionID, mks.si.api.LockType lockType, mks.si.api.ChangePackageID changePackageID)
      Construct a ScriptLockRevisionArgumentsBean object.
      ScriptLockRevisionArgumentsBean​(mks.si.brain.api.LocalRevision localRevision, mks.si.api.ChangePackageID changePackageID)
      Construct a ScriptLockRevisionArgumentsBean object.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getChangePackage()
      Returns the change package identifier associated with this operation.
      java.lang.String getExposedName()
      Returns the name of this bean that is exposed to the scripting language.
      java.lang.String getLockType()
      Returns type of lock whether exclusive lock or exclusive branching lock
      ScriptRevisionBean getRevisionBean()
      Returns a bean for the revision that is being locked.

      • 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

      • ScriptLockRevisionArgumentsBean

        public ScriptLockRevisionArgumentsBean​(mks.si.brain.api.LocalMember localMember,
                                       mks.si.api.RevisionID revisionID,
                                       mks.si.api.LockType lockType,
                                       mks.si.api.ChangePackageID changePackageID)
        Construct a ScriptLockRevisionArgumentsBean object.
        Parameters:
        localMember - The member that is having one of its revision's locked.
        revisionID - The identifier of the revision being locked.
        changePackageID - The identifier of the change package associated with this piece of work.

      • ScriptLockRevisionArgumentsBean

        public ScriptLockRevisionArgumentsBean​(mks.si.brain.api.LocalRevision localRevision,
                                       mks.si.api.ChangePackageID changePackageID)
        Construct a ScriptLockRevisionArgumentsBean object.
        Parameters:
        localRevision - The revision being locked.
        changePackageID - The identifier of the change package associated with this piece of work.

    • Method Detail

      • getExposedName

        public java.lang.String getExposedName()
        Returns the name of this bean that is exposed to the scripting language.
        Specified by:
        getExposedName in interface mks.frame.triggers.ScriptExposableBean
        Specified by:
        getExposedName in class ScriptBaseBean
        Returns:
        The bean's exposed name: siLockRevisionArgumentsBean.

      • getRevisionBean

        public ScriptRevisionBean getRevisionBean()
        Returns a bean for the revision that is being locked.
        Returns:
        A ScriptRevisionBean object of the revision being locked.

      • getChangePackage

        public java.lang.String getChangePackage()
        Returns the change package identifier associated with this operation.
        Returns:
        the string change package identifier, or the default string if the argument was not provided.

      • getLockType

        public java.lang.String getLockType()
        Returns type of lock whether exclusive lock or exclusive branching lock
        Returns:
        String type of lock