Package mks.si.brain.triggers.beans

Class ScriptSetMemberRuleArgumentsBean

  • All Implemented Interfaces:
    mks.frame.triggers.ScriptExposableBean
    public class ScriptSetMemberRuleArgumentsBean
extends ScriptBaseBean
implements mks.frame.triggers.ScriptExposableBean
    The class for arguments to a check in API call; this bean is available during a Member.checkIn event. A ScriptMemberBean object is also available for determining what member member is being checked in.
    See Also:
    ScriptMemberBean

    • Constructor Summary

      Constructors 
      Constructor Description
      ScriptSetMemberRuleArgumentsBean​(mks.si.api.RevisionID rule, boolean override)
      Construct a ScriptSetMemberRuleArgumentsBean object.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getExposedName()
      Returns the name of this bean that is exposed to the scripting language.
      java.lang.String getRule()
      Returns the rule being set.
      boolean overrideExistingRule()
      Whether or not to an existing rule should be overriden

      • 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

      • ScriptSetMemberRuleArgumentsBean

        public ScriptSetMemberRuleArgumentsBean​(mks.si.api.RevisionID rule,
                                        boolean override)
        Construct a ScriptSetMemberRuleArgumentsBean object.

    • 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 script-exposed bean name: siSetMemberRuleArgumentsBean.

      • getRule

        public java.lang.String getRule()
        Returns the rule being set.
        Returns:
        A String object containing the target rule

      • overrideExistingRule

        public boolean overrideExistingRule()
        Whether or not to an existing rule should be overriden
        Returns:
        true if we are supposed to override existing rules, false otherwise.