Class CopyTree.ScriptBranchArgsBean

  • All Implemented Interfaces:
    mks.frame.triggers.ScriptExposableBean
    Enclosing class:
    CopyTree

    public static class CopyTree.ScriptBranchArgsBean
    extends CopyTree.ScriptArgsBaseBean
    implements mks.frame.triggers.ScriptExposableBean
    The Branch Arguments Bean (imBranchArgsBean).

    This bean is available when the branch trigger is fired.

    The pre branch trigger is fired before a particular issue branch operation starts, and simply provides the information supplied by the client, along with the particular issue number being branched.

    The post branch trigger is fired after the branch or copytree operation has committed. At this point, it has completed. Both this bean, and the imBranchResultBean (see CopyTree.ScriptBranchResultBean) are available.

    If the copytree operation has the branch operation set, you will get both CopyTree and Branch triggers. The order that they will fire is:

    1. First the pre CopyTree will fire passing in all top level issues
    2. As each individual issue is branched, it will separately fire the pre Branch trigger for that issue
    3. The database commit occurs
    4. After the full CopyTree operation has completed, the post Branch triggers will all fire sequentially. One post Branch trigger will fire for each branched issue, giving the old and new issue ids.
    5. The post CopyTree will now fire, giving the full map of all branched issues.
    In summary, you will get one pre and one post CopyTree trigger; and you will get N pre and N post Branch triggers, where N is the number of branched issues.
    • Constructor Detail

      • ScriptBranchArgsBean

        public ScriptBranchArgsBean​(mks.ci.common.CopyTreeArgs args,
                                    int issueID,
                                    int userId,
                                    java.sql.Connection c)
    • Method Detail

      • getIssueID

        public int getIssueID()
        Fetch the issue id of the issue being branched.
        Returns:
        the integer issue id.
      • getExposedName

        public java.lang.String getExposedName()
        The name of this bean: imBranchArgsBean
        Specified by:
        getExposedName in interface mks.frame.triggers.ScriptExposableBean
        Specified by:
        getExposedName in class ScriptBaseBean
        Returns:
        the bean name: siMemberBean.