Package com.atlassian.bamboo.chains.branches

Interface BranchStatusService

All Known Implementing Classes:
BranchStatusServiceImpl
public interface BranchStatusService
Service with functions related to branch status page.
Since:
5.14

  • Method Summary

    Modifier and Type
    Method
    Description
    @NotNull BranchStatusLinkInfo
    getBranchStatusLinkInfo(@NotNull ImmutablePlan plan, @Nullable String navigationSource)
    Provides information about branch status link for the given plan - whether the link should or should not be displayed and what is the direct URL for this plan's VCS branch.
    boolean
    shouldDisplayBranchStatusLink(@NotNull ImmutablePlan plan)
    Whether a link to branch status page should be displayed for the given plan.

  • Method Details

    • getBranchStatusLinkInfo

      @NotNull @NotNull BranchStatusLinkInfo getBranchStatusLinkInfo(@NotNull @NotNull ImmutablePlan plan, @Nullable @Nullable String navigationSource)
      Provides information about branch status link for the given plan - whether the link should or should not be displayed and what is the direct URL for this plan's VCS branch.
      Parameters:
      plan - plan, for which the URL is to be generated
      navigationSource - navigation source of the link (where is it going to appear), e.g. 'email' or 'header'
      Returns:
      branch status link info

    • shouldDisplayBranchStatusLink

      boolean shouldDisplayBranchStatusLink(@NotNull @NotNull ImmutablePlan plan)
      Whether a link to branch status page should be displayed for the given plan.