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

Interface DocumentWorkItems

All Superinterfaces:
Iterable<WorkItem>, IterableWithSize<WorkItem>
All Known Subinterfaces:
UpdatableDocumentWorkItems
public interface DocumentWorkItems extends IterableWithSize<WorkItem>
Iterating over this instance returns all of a document's Work Items. (Even those that are unreferenced.)
Since:
3.9.0

  • Method Details

    • contained

      @NotNull IterableWithSize<WorkItem> contained()
      Returns an ordered collection of the active Work Items contained in the Document.

    • unreferenced

      @NotNull IterableWithSize<WorkItem> unreferenced()
      Returns the unreferenced Work Items contained in the Document. (Even when the document is from a specific revision.) Works correctly only after a commit.
      Returns:
      unreferenced Work Items (not null)

    • filtered

      @NotNull IterableWithSize<WorkItem> filtered(@NotNull String query)
      Filters active Work Items from the Document based on a query and returns an un-ordered collection of maching items and their ancestors.
      Parameters:
      query - Lucene query, a null or empty string will not filter results.

    • isInternal

      boolean isInternal(@NotNull WorkItem workItem)

    • revisionOfWorkItem

      @Nullable String revisionOfWorkItem(@NotNull WorkItem workItem)
      Gets the revision of a Work Item within the document.
      Returns:
      the revision of a Work Item if the Work Item is frozen to a specific revision or null if it is either in the HEAD revision or an internal Work Item.
      Since:
      3.10.2