Package com.polarion.alm.tracker

Interface IModuleWorkItemsQueryBuilder

public interface IModuleWorkItemsQueryBuilder
Creates a query for Document Work Items.

When filtering the Work Items with an additional query, using this builder is preferred to creating the combined query manually (e.g. with the help of IModuleManager.getModuleWorkItemsQuery(com.polarion.alm.projects.model.IProject, com.polarion.subterra.base.location.ILocation)) because this builder is able to create a more optimized query.

The optimization is done for outline number queries. If the outline number is queried without a reference to the Document, then the current Document reference is added. For example "outlineNumber:2*" is optimized to "outlineNumber:("myProject/mySpace/myDocument", "2*")".

Since:
3.17.2
See Also:

  • Method Details

    • filterBy

      @NotNull IModuleWorkItemsQueryBuilder filterBy(@Nullable String query)
      Additional Work Item query to filter the Work Items of the Document (optional).

      Note that the built query will not match the ancestors of Work Items matching the query (compare to IModule.filterWorkItems(String)).

    • excludeUnreferenced

      @NotNull IModuleWorkItemsQueryBuilder excludeUnreferenced(boolean excludeUnreferenced)
      Whether unreferenced Work Items should be matched by the query. (Optional, the default is to include them).

    • finish

      @NotNull String finish()
      Creates and returns the result of this builder - the Document Work Items query.