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

Interface DocumentLinkBuilder

All Superinterfaces:
LinkBuilderWithSelection, PortalLink
public interface DocumentLinkBuilder extends LinkBuilderWithSelection
Since:
3.9.0

  • Method Details

    • revision

      @NotNull DocumentLinkBuilder revision(@Nullable String value)
      Returns new builder for creating the link to the revision, so this instance can be still used to create link without revision. Never returns null. The returned builder can be also used as the link if no other parameters are needed.
      Parameters:
      value - - can be null or empty, than it will not be in the created url

    • compareView

      @NotNull PortalLink compareView(@NotNull String revision, @NotNull String revision2)

    • tabTree

      @NotNull DocumentTreeLinkBuilder tabTree()
      Returns new builder for creating the links to tree tab, never null. The returned builder can be also used as the link if no other parameters are needed.

    • filter

      @NotNull DocumentLinkBuilder filter(@Nullable String query)

    • sidebarTestRun

      @NotNull DocumentLinkBuilder sidebarTestRun(@Nullable String testRunPath)
      Parameters:
      testRunPath - projectId/testRunId (project part can be omitted if the test run is in the current project)

    • tab

      @NotNull DocumentLinkBuilder tab(@NotNull String tab)

    • history

      @NotNull DocumentLinkBuilder history()

    • sidebarApprovals

      @NotNull DocumentLinkBuilder sidebarApprovals(boolean myApprovals)

    • sidebarSignatures

      @NotNull DocumentLinkBuilder sidebarSignatures(@Nullable String status, boolean mySignatures)

    • sorting

      @NotNull DocumentLinkBuilder sorting(@Nullable String sorting)
      Since:
      3.10.2

    • anchor

      @NotNull DocumentLinkBuilder anchor(@Nullable String anchor)
      Since:
      3.18.2 Add an anchor parameter that's used when creating a cross-reference link.