Package mks.si.brain.triggers.beans

Class ScriptNewSubprojectArgumentsBean

  • All Implemented Interfaces:
    mks.frame.triggers.ScriptExposableBean
    public class ScriptNewSubprojectArgumentsBean
extends ScriptBaseBean
implements mks.frame.triggers.ScriptExposableBean
    The class for arguments to a new subproject API call; this bean is available during a Project.newSubproject event.
    See Also:
    ScriptProjectBean, ScriptSubprojectBean

    • Constructor Summary

      Constructors 
      Constructor Description
      ScriptNewSubprojectArgumentsBean​(mks.si.api.SubprojectID subprojectID, mks.si.api.ChangePackageID changePackageID)
      Construct a ScriptNewSubprojectArgumentsBean object.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getChangePackage()
      Returns the identification of the change package that this new subproject corresponds to.
      java.lang.String getExposedName()
      Returns the name of this bean that is exposed to the scripting language.
      java.lang.String getSubprojectPath()
      Returns the path to the subproject that is being created.

      • 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

      • ScriptNewSubprojectArgumentsBean

        public ScriptNewSubprojectArgumentsBean​(mks.si.api.SubprojectID subprojectID,
                                        mks.si.api.ChangePackageID changePackageID)
        Construct a ScriptNewSubprojectArgumentsBean object.
        Parameters:
        subprojectID - The identifier of the subproject to create.

    • 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: siNewSubprojectArgumentsBean.

      • getSubprojectPath

        public java.lang.String getSubprojectPath()
        Returns the path to the subproject that is being created.
        Returns:
        A String object containing the subproject's path.

      • getChangePackage

        public java.lang.String getChangePackage()
        Returns the identification of the change package that this new subproject corresponds to.
        Returns:
        a string version of the change package identifier.