Summary: Methods | [Expand All]
@PublicSpi public interface

RestFieldOperationsHandler

com.atlassian.jira.issue.fields.rest.RestFieldOperationsHandler
Known Indirect Subclasses

@PublicSpi

This interface is designed for plugins to implement.

Clients of @PublicSpi can expect that programs compiled against a given version will remain binary compatible with later versions of the @PublicSpi as per each product's API policy (clients should refer to each product's API policy for the exact guarantee -- usually binary compatibility is guaranteed at least across minor versions).

Note: @PublicSpi interfaces and classes are specifically designed to be implemented/extended by clients. Hence, the guarantee of binary compatibility is different to that of @PublicApi elements (if an element is both @PublicApi and @PublicSpi, both guarantees apply).

Class Overview

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

Summary

Public Methods
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.

Public Methods

public Set<String> getSupportedOperations ()

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

Returns
  • a set of supported Operations

public 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.