Interface PlanUtils


  • public interface PlanUtils
    Collection of helper methods related to one Plan.
    Since:
    3.9.0
    • Method Detail

      • wasStarted

        boolean wasStarted()
        Returns true if plan status is different from initial (default) status, false otherwise.
        Returns:
        whether plan status is different from initial status
      • isFinished

        boolean isFinished()
        Returns true if plan is finished.
      • getFinishedPlan

        @Nullable
        Plan getFinishedPlan()
        Gets an Plan state from the revision in which plan was finished
      • currentDate

        @NotNull
        java.util.Date currentDate()
        Returns 'now' if plan is from HEAD or time when plan's revision (or baseline revision) was created.
      • idealProgressFactor

        float idealProgressFactor​(@NotNull
                                  java.util.Date date)
        Return ideal progress factor for the plan. Value is 0 at plan's start and is 1 at plan's end.
        Parameters:
        date - current date
      • statusName

        @NotNull
        java.lang.String statusName()
        return status name of a plan.
      • getPrioritizationLink

        @NotNull
        PortalLink getPrioritizationLink()
        Returns link that can be used in UI for prioritizing items of the plan.
        Since:
        3.9.1
      • getOpenInTableLink

        @NotNull
        PortalLink getOpenInTableLink()
        Returns link that can be used in UI for showing items of the plan.
        Since:
        3.9.1
      • isRichPagePlan

        boolean isRichPagePlan()
        Returns:
        true if this Plan's report is Rich Page based.
        Since:
        3.9.2
      • getResolvableItems

        @NotNull
        IterableWithSize<WorkItem> getResolvableItems()
        Returns items from the plan that still exist. The iterator never returns null value. The result is computed using database which is faster, but ignores not saved changes in the Plan object.
        Since:
        3.9.2