Interface Fields

All Superinterfaces:
Iterable<Field>, IterableWithSize<Field>
All Known Subinterfaces:
ApprovalFields, AttachmentBaseFields, BaselineCollectionElementFields, BaselineCollectionFields, BaselineFields, BuildFields, CategoryFields, CommentBaseFields, CommentFields, DocumentFields, DocumentWorkflowSignatureFields, EnumOptionFields, ExternallyLinkedWorkItemFields, FeatureSelectionItemFields, HyperlinkFields, LinkedOslcResourceFields, LinkedResourceFields, LinkedWorkItemFields, PlanFields, PlanningConstraintFields, ProjectFields, RevisionFields, RichPageFields, SignatureFields, TestRecordFields, TestRunFields, TestStepResultFields, TimePointFields, UpdatableBaselineCollectionFields, UpdatableBaselineFields, UpdatableCategoryFields, UpdatableDocumentFields, UpdatableLinkedWorkItemFields, UpdatablePlanFields, UpdatableProjectFields, UpdatableRichPageFields, UpdatableTestRunFields, UpdatableTimePointFields, UpdatableUserFields, UpdatableUserGroupFields, UpdatableWorkItemFields, UserFields, UserGroupFields, WikiPageFields, WorkflowSignatureFields, WorkItemFields, WorkRecordFields

public interface Fields extends IterableWithSize<Field>
Since:
3.9.0
  • Method Details

    • get

      @NotNull Field get(@NotNull String id)
      Returns an "undefined field" instance for an undefined field.
    • getByPath

      @NotNull Field getByPath(@NotNull String path)
      Returns the field that's identified by the path, in a dot notation format. Returns an "undefined field" instance for an undefined field. The dot notation format makes it possible to dive into ScalarFields that return objects implementing HasFields. Example: With a "field1.field2" path, first the "field1" field of this object is found, and if it is a ScalarField and its value implements HasFields, then its "field2" field is returned. Otherwise an "undefined field" is returned.
      Parameters:
      path - The path to the field in a dot notation format.
      Since:
      3.17.3