public abstract class

AbstractFieldOperationsHandler

extends Object
implements RestFieldOperationsHandler
java.lang.Object
   ↳ com.atlassian.jira.issue.fields.rest.AbstractFieldOperationsHandler<T>
Known Direct Subclasses
Known Indirect Subclasses

Summary

Fields
protected final I18nHelper i18nHelper
Public Constructors
AbstractFieldOperationsHandler(I18nHelper i18nHelper)
Public Methods
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.
Protected Methods
T applyOperation(IssueContext issueCtx, Issue issue, String fieldId, StandardOperation operation, T currentFieldValue, JsonData operationValue, ErrorCollection errors)
gets called (perhaps multiple times) to apply the given operation to the given currentValuye, retyrning the new value
abstract void finaliseOperation(T finalValue, IssueInputParameters parameters, ErrorCollection errors)
takes the valuye returnd by a call to applyOperation() and puts it into the inputparams
abstract T getInitialCreateValue()
compute the "currentValue" to be passed to applyOperation()
abstract T getInitialValue(Issue issue, ErrorCollection errors)
compute the "currentValue" to be passed to applyOperation()
T handleAddOperation(IssueContext issueCtx, Issue issue, String fieldId, T currentFieldValue, JsonData operationValue, ErrorCollection errors)
T handleRemoveOperation(IssueContext issueCtx, Issue issue, String fieldId, T currentFieldValue, JsonData operationValue, ErrorCollection errors)
T handleSetOperation(IssueContext issueCtx, Issue issue, String fieldId, T currentFieldValue, JsonData operationValue, ErrorCollection errors)
Long[] toLongIds(Collection<String> ids, String fieldName, ErrorCollection errors)
[Expand]
Inherited Methods
From class java.lang.Object
From interface com.atlassian.jira.issue.fields.rest.RestFieldOperationsHandler

Fields

protected final I18nHelper i18nHelper

Public Constructors

public AbstractFieldOperationsHandler (I18nHelper i18nHelper)

Public Methods

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.

Protected Methods

protected T applyOperation (IssueContext issueCtx, Issue issue, String fieldId, StandardOperation operation, T currentFieldValue, JsonData operationValue, ErrorCollection errors)

gets called (perhaps multiple times) to apply the given operation to the given currentValuye, retyrning the new value

protected abstract void finaliseOperation (T finalValue, IssueInputParameters parameters, ErrorCollection errors)

takes the valuye returnd by a call to applyOperation() and puts it into the inputparams

protected abstract T getInitialCreateValue ()

compute the "currentValue" to be passed to applyOperation()

protected abstract T getInitialValue (Issue issue, ErrorCollection errors)

compute the "currentValue" to be passed to applyOperation()

protected T handleAddOperation (IssueContext issueCtx, Issue issue, String fieldId, T currentFieldValue, JsonData operationValue, ErrorCollection errors)

protected T handleRemoveOperation (IssueContext issueCtx, Issue issue, String fieldId, T currentFieldValue, JsonData operationValue, ErrorCollection errors)

protected T handleSetOperation (IssueContext issueCtx, Issue issue, String fieldId, T currentFieldValue, JsonData operationValue, ErrorCollection errors)

protected Long[] toLongIds (Collection<String> ids, String fieldName, ErrorCollection errors)