@ExperimentalApi public interface

OptionsService

com.atlassian.jira.issue.customfields.manager.OptionsService
Known Indirect Subclasses

@ExperimentalApi

This interface is considered usable by external developers but its contracts have not stabilized.

Experimental APIs may be changed at any time before being marked @Internal or @PublicApi.

Class Overview

A service to manipulate the options associated with a CustomField.

Summary

Nested Classes
class OptionsService.SetOptionParams  
interface OptionsService.SetValidateResult  
Public Methods
@Nonnull ServiceOutcome<Options> setOptions(OptionsService.SetValidateResult request)
Replace the options on the custom field.
@Nonnull ServiceOutcome<OptionsService.SetValidateResult> validateSetOptions(OptionsService.SetOptionParams param)
Check that the options of a CustomField can be replaced with (i.e.

Public Methods

@Nonnull public ServiceOutcome<Options> setOptions (OptionsService.SetValidateResult request)

Replace the options on the custom field. The current options will be deleted (along with their values) and new options created. No attempt is made to keep the current options or their values (i.e. even if an option has the same name before and after the operation). The options are set to the values passed to the validateSetOptions(com.atlassian.jira.issue.customfields.manager.OptionsService.SetOptionParams) that generated the passed OptionsService.SetValidateResult.

Returns
  • the result of the operation.

@Nonnull public ServiceOutcome<OptionsService.SetValidateResult> validateSetOptions (OptionsService.SetOptionParams param)

Check that the options of a CustomField can be replaced with (i.e. current options deleted and set to) the passed options. The actual operation will not be executed until a call to setOptions(com.atlassian.jira.issue.customfields.manager.OptionsService.SetValidateResult) is later made.

Parameters
param the request.
Returns