Package com.polarion.alm.tracker

Interface IRichPageSelector<T>

public interface IRichPageSelector<T>
Interface for selecting the rich page using optional project id and revision and mandatory page path or space id and page name. The selection is finished by using path(String) or spaceAndName(String, String) method and the selector object cannot be used anymore after that.
Since:
3.9.0

  • Method Details

    • project

      @NotNull IRichPageSelector<T> project(@Nullable String projectId)
      Optionally specify a project, must be used before path(String) or spaceAndName(String, String)
      Returns:
      returns the same instance to allow method chaining
      Throws:
      IllegalStateException - after the selection was finished

    • revision

      @NotNull IRichPageSelector<T> revision(@Nullable String revision)
      Optionally specify a revision, must be used before path(String) or spaceAndName(String, String)
      Returns:
      returns the same instance to allow method chaining
      Throws:
      IllegalStateException - after the selection was finished

    • path

      @NotNull T path(@NotNull String pagePath)
      Finishes selecting the page using the relative path to page.
      Parameters:
      pagePath - - the path is separated by slash ('/') and when it does not contain the slash, then the _default space is assumed
      Throws:
      IllegalStateException - after the selection was finished

    • spaceAndName

      @NotNull T spaceAndName(@Nullable String spaceId, @NotNull String pageName)
      Finishes selecting the page using the space id and page name as separate parameters.
      Parameters:
      spaceId - - The space id. When null, then the _default space is assumed
      Throws:
      IllegalStateException - after the selection was finished