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

Interface ProjectLinkBuilder

All Superinterfaces:
PortalLink
public interface ProjectLinkBuilder extends PortalLink
Since:
3.9.0

  • Method Details

    • workItem

      @NotNull WorkItemLinkBuilder workItem(@NotNull String id)
      Return builder for building links to a Work Items. 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()
      Return builder for building links to Work Items. The returned builder can be also used as the link if no other parameters are needed.

    • document

      @NotNull DocumentLinkBuilder document(@Nullable String space, @NotNull String name)
      Return builder for building links to a Document. The returned builder can be also used as the link if no other parameters are needed.

    • testRun

      @NotNull TestRunLinkBuilder testRun(@NotNull String id)
      Return builder for building links to a Test Run. 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

    • plan

      @NotNull PlanLinkBuilder plan(@NotNull String id)
      Return builder for building links to a Plan. 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

    • testRuns

      @NotNull TestRunsLinkBuilder testRuns()
      Return builder for building links to Test Runs. The returned builder can be also used as the link if no other parameters are needed.

    • plans

      @NotNull PlansLinkBuilder plans()
      Return builder for building links to Plans. The returned builder can be also used as the link if no other parameters are needed.

    • richPage

      @NotNull RichPageLinkBuilder richPage(@Nullable String spaceId, @NotNull String name)
      Return builder for building links to a Rich Pages. The returned builder can be also used as the link if no other parameters are needed.

    • wikiPage

      @NotNull WikiPageLinkBuilder wikiPage(@Nullable String spaceId, @NotNull String name)
      Return builder for building links to a Wiki Pages. The returned builder can be also used as the link if no other parameters are needed.

    • space

      @NotNull SpaceLinkBuilder space(@Nullable String spaceId)
      Return builder for building links to a Space.
      Since:
      3.10.1

    • administration

      @NotNull AdministrationLinkBuilder administration()
      Return builder for building links to Administration.

    • build

      @NotNull PortalLink build(@NotNull String id)

    • home

      @NotNull PortalLink home()

    • baseline

      @NotNull BaselineLinkBuilder baseline(@NotNull String id)
      Return builder for building links to a Baseline.
      Since:
      3.19.2

    • baselineCollection

      @NotNull BaselineCollectionLinkBuilder baselineCollection(@NotNull String collectionId)
      Returns the builder that builds the links to a Baseline Collection form. To create a link to a Baseline Collection context, use baselineCollectionContext(String).
      Since:
      3.20.1

    • baselineCollections

      @NotNull BaselineCollectionsLinkBuilder baselineCollections()
      Returns the builder that builds the links to Baseline Collections. The returned builder can be also used as the link if no other parameters are needed.
      Since:
      3.20.2

    • baselineCollectionContext

      @NotNull ProjectLinkBuilder baselineCollectionContext(@NotNull String collectionId)
      Returns the builder that builds the links to a Baseline Collection's context. (The link will open the target within the Collection.) If the Baseline Collection is not from the current project scope, use baselineCollectionContext(String, String).

      To create a link to a Baseline Collection form, use baselineCollection(String).

      Since:
      3.20.1

    • baselineCollectionContext

      @NotNull ProjectLinkBuilder baselineCollectionContext(@NotNull String collectionProjectId, @NotNull String collectionId)
      Returns the builder that builds the links to a Baseline Collection's context. (The link will open the target within the Collection.)

      To create a link to a Baseline Collection form, use baselineCollection(String).

      Since:
      3.20.2

    • baselineCollectionContext

      @NotNull ProjectLinkBuilder baselineCollectionContext(@NotNull String collectionProjectId, @NotNull String collectionId, @Nullable String collectionRevision)
      Returns the builder that builds the links to a Baseline Collection's context. (The link will open the target within the Collection.)

      To create a link to a Baseline Collection form, use baselineCollection(String).

      Since:
      3.20.2