com.atlassian.jira.issue.fields.rest

Interface RestAwareField

All Known Subinterfaces:

CustomField

All Known Implementing Classes:

AbstractAggregateDurationSystemField, AbstractDurationSystemField, AbstractProgressBarSystemField, AbstractTextSystemField, AbstractVersionsSystemField, AffectedVersionsSystemField, AggregateEstimateSystemField, AggregateOriginalEstimateSystemField, AggregateProgressBarSystemField, AggregateTimeSpentSystemField, ArchivedDateSystemField, ArchivedUserSystemField, AssigneeSystemField, AttachmentSystemField, CommentSystemField, ComponentsSystemField, CreatedSystemField, CreatorSystemField, DescriptionSystemField, DueDateSystemField, EnvironmentSystemField, FixVersionsSystemField, ImmutableCustomField, IssueLinksSystemField, IssueTypeSystemField, LabelsSystemField, LastViewedSystemField, MockCustomField, OriginalEstimateSystemField, PrioritySystemField, ProgressBarSystemField, ProjectSystemField, ReporterSystemField, ResolutionDateSystemField, ResolutionSystemField, SecurityLevelSystemField, StatusSystemField, SubTaskSystemField, SummarySystemField, TimeEstimateSystemField, TimeSpentSystemField, TimeTrackingSystemField, UpdatedSystemField, VotesSystemField, WatchesSystemField, WorklogSystemField, WorkRatioSystemField

@PublicApi
public interface RestAwareField

Fields that implement this interface can:

• Supply meta data for the REST APIs to use.
• Optionally Process command verbs from rest resoucres.
• Format their data into beans that can be used to generate meaningful REST values.

Since:

v5.0

Method Summary

Modifier and Type	Method and Description
FieldTypeInfo	getFieldTypeInfo(FieldTypeInfoContext fieldTypeInfoContext) Returns lower level Information about the field.
FieldJsonRepresentation	getJsonFromIssue(Issue issue, boolean renderedVersionRequested, FieldLayoutItem fieldLayoutItem) Return a FieldJsonDataPair containing a json representation of the raw data for this field, and if required, a json representation of the rendered data for easy display.
JsonType	getJsonSchema() Return a description of the shape of this field when represented as JSON.

Method Detail

getFieldTypeInfo

FieldTypeInfo getFieldTypeInfo(FieldTypeInfoContext fieldTypeInfoContext)

Returns lower level Information about the field. This information contains allowed values and/or the autocomplete url

Parameters:

fieldTypeInfoContext - the FieldTypeInfoContext contains context information that is relevant to generate the FieldTypeInfo

getJsonSchema

JsonType getJsonSchema()

Return a description of the shape of this field when represented as JSON.

getJsonFromIssue

FieldJsonRepresentation getJsonFromIssue(Issue issue,
                                         boolean renderedVersionRequested,
                                         @Nullable
                                         FieldLayoutItem fieldLayoutItem)

Return a FieldJsonDataPair containing a json representation of the raw data for this field, and if required, a json representation of the rendered data for easy display.

Parameters:

issue - to get field data from

renderedVersionRequested - whether the use requested the return of rendered/pretty data as well as raw data

fieldLayoutItem - field layout for this field. Will only be supplied if the field is also an ordereable field.

Returns:

FieldJsonDataPair containing a json representation of the raw data for this field, and if required, a json representation of the rendered data for easy display.