com.atlassian.jira.issue.fields.rest

Interface RestFieldOperationsHandler

All Known Implementing Classes:

AbstractCustomFieldOperationsHandler, AbstractFieldOperationsHandler, AbstractVersionsRestFieldOperationsHandler, AffectedVersionsRestFieldOperationsHandler, AssigneeRestFieldOperationsHandler, CascadingSelectCustomFieldOperationsHandler, CommentRestFieldOperationsHandler, ComponentsRestFieldOperationsHandler, DateCustomFieldOperationsHandler, DateTimeCustomFieldOperationsHandler, DescriptionRestFieldOperationsHandler, DueDateRestFieldOperationsHandler, EnvironmentRestFieldOperationsHandler, FixForVersionsRestFieldOperationsHandler, GroupCustomFieldOperationsHandler, IssueLinksRestFieldOperationsHandler, LabelsCustomFieldOperationsHandler, LabelsRestFieldOperationsHandler, MultiGroupCustomFieldOperationsHandler, MultiSelectCustomFieldOperationsHandler, MultiUserCustomFieldOperationsHandler, MultiVersionCustomFieldOperationsHandler, NumberCustomFieldOperationsHandler, PriorityRestFieldOperationsHandler, ProjectCustomFieldOperationsHandler, ReporterRestFieldOperationsHandler, ResolutionRestFieldOperationsHandler, SecurityLevelRestFieldOperationsHandler, SelectCustomFieldOperationsHandler, SingleVersionCustomFieldOperationsHandler, SummaryRestFieldOperationsHandler, TextCustomFieldOperationsHandler, TimeTrackingRestFieldOperationsHandler, UserCustomFieldOperationsHandler, WorklogRestFieldOperationsHandler

@PublicSpi
public interface RestFieldOperationsHandler

The RestFieldOperationsHandler is called by the issue rest source to handle the update issue request.

Since:

v5.0

Method Summary

Methods

Modifier and Type	Method and Description
Set<String>	getSupportedOperations() Returns a list of operation names which are supported by this field.
ErrorCollection	updateIssueInputParameters(IssueContext issueCtx, Issue issue, String fieldId, IssueInputParameters inputParameters, List<FieldOperationHolder> operations) This method has to set the field value(s) in the IssueInputParameters based on the operations.

Method Detail

getSupportedOperations

Set<String> getSupportedOperations()

Returns a list of operation names which are supported by this field.

Returns:

a set of supported Operations

updateIssueInputParameters

ErrorCollection updateIssueInputParameters(IssueContext issueCtx,
                                         Issue issue,
                                         String fieldId,
                                         IssueInputParameters inputParameters,
                                         List<FieldOperationHolder> operations)

This method has to set the field value(s) in the IssueInputParameters based on the operations. The issue service will validate the new field values in the IssueInputParameters, thus all permission checks are done by the issue service.

Parameters:

issueCtx - the Issue Context , i.e. Project IssueType

issue - the issue (may be null when creating an issue)

fieldId - The Id of the field being processed.

inputParameters - the inputparameters containing all updatd field values.

operations - the operations to perform for this field. Has to be one of the supported operations.

Returns:

contains errors, if there was a problem when setting the field values on the IssueInputParameters. No errors if it was able to update the IssueInputParameters.