Package com.polarion.alm.shared.api.utils.links

Interface PortalLinkBuilder

public interface PortalLinkBuilder
Instances can be obtained from SharedContext.createPortalLink()
Since:
3.9.0

  • Method Details

    • repository

      @NotNull RepositoryLinkBuilder repository()
      Returns builder for building links to repository scope. The returned builder can be also used as the link if no other parameters are needed.

    • projectGroup

      @NotNull ProjectGroupLinkBuilder projectGroup(@Nullable String projectGroupPath)
      Returns builder for building links to project group scope. The returned builder can be also used as the link if no other parameters are needed.
      Parameters:
      projectGroupPath - path to project group where / is used as delimiter. Can be null or empty - than it means "repository", which can be also represented as single /

    • project

      @NotNull ProjectLinkBuilder project(@NotNull String id)
      Returns builder for building links to project scope. The returned builder can be also used as the link if no other parameters are needed.
      Parameters:
      id - can not be null or empty
      Throws:
      IllegalArgumentException - if project is null or empty

    • workItems

      @NotNull WorkItemsLinkBuilder workItems()
      Returns the builder that creates links to Work Items for the global scope. The returned builder can also be used as the link if no other parameters are required.
      Since:
      3.23.4

    • outsideOfBaseline

      @NotNull PortalLinkBuilder outsideOfBaseline()
      Returns builder for building links outside of the baseline. Should be used only in exceptional cases when the link should really go outside of baseline The returned builder can be also used as the link if no other parameters are needed.

    • baseline

      @NotNull PortalLinkBuilder baseline(@Nullable String baselineRevision)
      Returns builder for building links inside of the specified baseline, The returned builder can be also used as the link if no other parameters are needed.