@PublicSpi public interface

MultipleSettableCustomFieldType

implements MultipleCustomFieldType<T, S>
com.atlassian.jira.issue.customfields.MultipleSettableCustomFieldType<T, S>
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

Custom field which can have multiple Options to select from. Provides support for removing a possible option from the Field configuration.

Summary

[Expand]
Inherited Constants
From interface com.atlassian.jira.issue.customfields.CustomFieldType
Public Methods
Set<Long> getIssueIdsWithValue(CustomField field, Option option)
Returns a Set of issue ids (Long) that have the given option selected.
void removeValue(CustomField field, Issue issue, Option optionObject)
Perform any actions required if the option selected by the issue is removed.
[Expand]
Inherited Methods
From interface com.atlassian.jira.issue.customfields.CustomFieldType
From interface com.atlassian.jira.issue.customfields.MultipleCustomFieldType

Public Methods

public Set<Long> getIssueIdsWithValue (CustomField field, Option option)

Returns a Set of issue ids (Long) that have the given option selected.

Parameters
field the CustomField to search on
option the Object representing a single value to search on.
Returns
  • Set of Longs

public void removeValue (CustomField field, Issue issue, Option optionObject)

Perform any actions required if the option selected by the issue is removed.

Parameters
field being edited
issue to remove stuff from
optionObject option being removed.