Package mks.si.brain.triggers.beans

Class ScriptDiscardChangePackageArgumentsBean

  • All Implemented Interfaces:
    mks.frame.triggers.ScriptExposableBean
    public class ScriptDiscardChangePackageArgumentsBean
extends ScriptBaseBean
implements mks.frame.triggers.ScriptExposableBean
    The class for arguments to a discard change package API call; this bean is available during a Server.discardChangePackage event.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getChangePackageID()
      Returns the identifier of the change package that was discarded.
      java.lang.String getExposedName()
      Returns the name of this bean that is exposed to the scripting language.

      • 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

      • ScriptDiscardChangePackageArgumentsBean

        public ScriptDiscardChangePackageArgumentsBean​(mks.si.api.ChangePackageID cpid)
        Construct a ScriptDiscardChangePackageArgumentsBean
        Parameters:
        cpid - the identifier of the change package that was discarded.

    • 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 name: siDiscardChangePackageArgumentsBean.

      • getChangePackageID

        public java.lang.String getChangePackageID()
        Returns the identifier of the change package that was discarded.
        Returns:
        a String containing the identifier of the change package that was discarded.