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

Interface Field

All Superinterfaces:

CanRender<Renderer<? extends Renderer<?>>>

All Known Subinterfaces:

ApprovalField, ApprovalsField, AttachmentBasesField, AttachmentBaseUrlField, AvatarField, BaselineCollectionElementsField, BaselineCollectionField, BaselineCollectionsField, BooleanField, CanBeCustomField, CategoriesField, CodeField, CodeStreamField, CommentBaseField<C>, CommentBasesField<C>, CommentBasesTreeField<C>, CommentField, CommentsField, CommentsTreeField, CurrencyField, DateField, DateOnlyField, DocumentField, DocumentWorkflowSignaturesField, DurationField, EnumOptionField, EnumOptionsField, FeatureSelectionField, FieldReferenceField, FieldReferencesField, FloatField, GlobalRolesField, HyperlinksField, HyperlinkUriField, IconUrlField, IdField, IntegerField, IterableField<E>, LinkedOslcResourcesField, LinkedResourcePositionField, LinkedResourcesField, LinkRulesField, LocationField, LongField, ModelObjectField, ModelObjectReferenceField<T>, ModelObjectsReferenceField<E>, ParametersAndDefinitionsField, ParametersField, PlainTextField, PlanField, PlanningConstraintField, PlanningConstraintsField, PlanProgressField, PlanRecordsField, PlansField, PlanWorkField, ProjectField, ProjectRolesField, ProjectsField, RevisionsField, RichPagesField, RichTextField, ScalarField<T>, SignaturesField, SpaceField, StringField, TableField, TestRecordsField, TestRunField, TestRunsField, TestStepResultsField, TestStepsField, TimeOnlyField, TimePointField, UpdatableBaselineCollectionElementsField, UpdatableBaselineCollectionsField, UpdatableBooleanField, UpdatableCanBeCustomField, UpdatableCategoriesField, UpdatableCodeStreamField, UpdatableCurrencyField, UpdatableDateField, UpdatableDateOnlyField, UpdatableDurationField, UpdatableEnumOptionField, UpdatableEnumOptionsField, UpdatableFieldReferenceField, UpdatableFloatField, UpdatableGlobalRolesField, UpdatableIntegerField, UpdatableLinkedOslcResourcesField, UpdatableLongField, UpdatableObjectReferenceField<T,R,S>, UpdatablePlainTextField, UpdatablePlanField, UpdatablePlanRecordsField, UpdatableProjectField, UpdatableProjectRolesField, UpdatableRichPagesField, UpdatableRichTextField, UpdatableScalarField<T>, UpdatableStringField, UpdatableTestRunField, UpdatableTestRunsField, UpdatableTimeOnlyField, UpdatableTimePointField, UpdatableUrlField, UpdatableUserField, UpdatableUsersField, UpdatableWorkItemField, UpdatableWorkItemLinkedWorkItemsField, UrlField, UserField, UsersField, WorkflowSignaturesField<T>, WorkItemField, WorkItemLinkedWorkItemsField, WorkItemsField, WorkRecordsField

public interface Field
extends CanRender<Renderer<? extends Renderer<?>>>

Common interface for model fields.

Since:

3.9.0

Method Summary

Modifier and Type	Method	Description
FieldPermissions	can()
FieldDifferences	compareWith(Field rightField)	Compares fields and returns the differences.
String	description()
String	id()
ReadOnlyFieldStateAnalyzer	is()
String	label()
Renderer<? extends Renderer<?>>	render()	This method can be used also when the parent object is unresolvable or user has no permission to access.

Method Details

id

@NotNull
String id()

label

@NotNull
String label()

description

@NotNull
String description()

is

@NotNull
ReadOnlyFieldStateAnalyzer is()

can

@NotNull
FieldPermissions can()

render

@NotNull
Renderer<? extends Renderer<?>> render()

This method can be used also when the parent object is unresolvable or user has no permission to access. In both cases the method will just render nothing and not throw any exceptions.

Specified by:

render in interface CanRender<Renderer<? extends Renderer<?>>>

compareWith

@NotNull
FieldDifferences compareWith(@NotNull
 Field rightField)

Compares fields and returns the differences. This field is the FieldDifferences.leftField() in the returned instance.

Since:

3.10.0