Package com.polarion.alm.shared.api.model

Interface ModelObjectSelector<T,S extends ModelObjectSelector<T,S,R>,R extends ModelObjectReference>

All Known Subinterfaces:
BaselineCollectionSelector<T>, BaselineSelector<T>, CategorySelector<T>, DocumentSelector<T>, PlanSelector<T>, ProjectSelector<T>, RichPageSelector<T>, TestRunBuilder<T>, TestRunSelector<T>, TimePointSelector<T>, UserGroupSelector<T>, UserSelector<T>, WikiPageSelector<T>, WorkItemSelector<T>
public interface ModelObjectSelector<T,S extends ModelObjectSelector<T,S,R>,R extends ModelObjectReference>
Since:
3.9.0

  • Method Summary

    Modifier and Type
    Method
    Description
    T
    oldApiObject(com.polarion.platform.persistence.model.IPObject object)
     
    T
    path(String path)
    Finishes selecting the object, overrides any previously specified values which are contained in the path.
    T
    reference(R reference)
    Completes the object selection.
    This method overrides any previously set values, for example revisions set through the revision(String) method.
    To request a reference in a specific revision, you can add the requested revision to the reference parameter by using the ModelObjectReference.getFromRevision(ReadOnlyTransaction, String) method.

    It is easier to use the ModelObjectReference.get(ReadOnlyTransaction) method than this one to get the instance of ModelObject for the given reference.
    S
    revision(String revision)
    This optional method can be used to specify the requested revision that the object should be loaded from.

  • Method Details

    • revision

      @NotNull S revision(@Nullable String revision)
      This optional method can be used to specify the requested revision that the object should be loaded from. If this method is used, it must be called before any other method that completes the object selection.
      Returns:
      the same instance to allow for method chaining.
      Throws:
      IllegalStateException - after the selection was completed.

    • path

      @NotNull T path(@NotNull String path)
      Finishes selecting the object, overrides any previously specified values which are contained in the path. The path is value returned by ModelObjectReference.toPath() of the appropriate reference type.

    • reference

      @NotNull T reference(@NotNull R reference)
      Completes the object selection.
      This method overrides any previously set values, for example revisions set through the revision(String) method.
      To request a reference in a specific revision, you can add the requested revision to the reference parameter by using the ModelObjectReference.getFromRevision(ReadOnlyTransaction, String) method.

      It is easier to use the ModelObjectReference.get(ReadOnlyTransaction) method than this one to get the instance of ModelObject for the given reference.

    • oldApiObject

      @NotNull @GwtIncompatible T oldApiObject(@NotNull com.polarion.platform.persistence.model.IPObject object)