Interface IModuleWorkItemsQueryBuilder
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 Summary
Modifier and TypeMethodDescriptionexcludeUnreferenced
(boolean excludeUnreferenced) Whether unreferenced Work Items should be matched by the query.Additional Work Item query to filter the Work Items of the Document (optional).finish()
Creates and returns the result of this builder - the Document Work Items query.
-
Method Details
-
filterBy
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
Whether unreferenced Work Items should be matched by the query. (Optional, the default is to include them). -
finish
Creates and returns the result of this builder - the Document Work Items query.
-