Class DecoratedPlan

    • Method Detail

      • getParent

        @Nullable
        public abstract @Nullable DecoratedPlan getParent()
        Specified by:
        getParent in interface DecoratedNavObject
        Returns:
        the parent of this object (does not take into account groups)
      • replaceKey

        @Nullable
        public @Nullable String replaceKey​(String url,
                                           DecoratedNavObject originalObject)
        Description copied from interface: DecoratedNavObject
        Given an existing url (may be directly from the originalObject or may be with a static ${planKey} reference) generate the new url for this object
        Specified by:
        replaceKey in interface DecoratedNavObject
        Parameters:
        url - - to manipulate
        originalObject - - the object the original url may have belonged to
        Returns:
        the new url referencing this object
      • getDatabaseId

        @NotNull
        public @NotNull Optional<Long> getDatabaseId()
        Specified by:
        getDatabaseId in interface PlanIdentifier
        Returns:
        database id of the plan or empty if this plan is not a DB object.
      • getMasterId

        public long getMasterId()
        Specified by:
        getMasterId in interface PlanIdentifier
        Returns:
        database id of master of this Plan or -1 if none.
      • getLabelNames

        public com.google.common.collect.ImmutableList<String> getLabelNames()
      • getType

        @NotNull
        public @NotNull String getType()
        Specified by:
        getType in interface DecoratedNavObject
        Returns:
        plantype associated with this object.
      • isResult

        public boolean isResult()
        Specified by:
        isResult in interface DecoratedNavObject
        Returns:
        true if the nav object represents a result otherwise false
      • isSuspendedFromBuilding

        public boolean isSuspendedFromBuilding()
        Description copied from interface: PlanIdentifier
        Checks if the build has been enabled / disabled.
        Specified by:
        isSuspendedFromBuilding in interface PlanIdentifier
        Returns:
        true if plan is disabled
      • getStages

        public com.google.common.collect.ImmutableList<DecoratedStage> getStages()
      • setLabels

        public void setLabels​(com.google.common.collect.ImmutableList<String> labels)
      • getBranchName

        @Nullable
        public abstract @Nullable String getBranchName()
      • getPlanBranchWorkflow

        @Nullable
        public abstract @Nullable PlanBranchWorkflow getPlanBranchWorkflow()
      • getLinkedJiraIssue

        @Nullable
        public @Nullable String getLinkedJiraIssue()
      • isRemoteJiraLinkRequired

        public boolean isRemoteJiraLinkRequired()
      • getMasterChainKey

        @NotNull
        public @NotNull String getMasterChainKey()
        Return the main chain key for this plan. In case of a Chain Key (PROJ-PLAN) this key will be returned. In case of a Job Key (PROJ-PLAN-JOB), this will return a main chain key (PROJ-PLAN). In case of a Branch Key (PROJ-PLAN10), this will return the key of the main chain (PROJ-PLAN).
        Returns:
        chainKey
      • getMasterJobKey

        @Nullable
        public @Nullable String getMasterJobKey()
        Return the job key of this plan. In case this class represents a chain key or a branch key, this will return null.
        Returns:
        the job key or null
      • getBranchPlanKey

        @Nullable
        public @Nullable String getBranchPlanKey()
        Return the the branch plan key. If this does not represent a branch plan, we return null.
        Returns:
        the branch plan key or null
      • getStageWithName

        @Nullable
        public abstract @Nullable DecoratedStage getStageWithName​(@NotNull
                                                                  @NotNull String stageName)
        Retrieve the named stage. If the stage is not found it indicates that the stage has been deleted or renamed but the result remains.