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

UserFilterManager

com.atlassian.jira.user.UserFilterManager
Known Indirect Subclasses

@PublicApi

This interface is designed for plugins to consume (call its methods).

Clients of @PublicApi can expect that programs compiled against a given version will remain binary compatible with later versions of the @PublicApi as per each product's API policy as long as the client does not implement/extend @PublicApi interfaces or classes (refer to each product's API policy for the exact guarantee---usually binary compatibility is guaranteed at least across minor versions).

Note: since @PublicApi interfaces and classes are not designed to be implemented or extended by clients, we may perform certain types of binary-incompatible changes to these classes and interfaces, but these will not affect well-behaved clients that do not extend/implement these types (in general, only classes and interfaces annotated with @PublicSpi are safe to extend/implement).

Class Overview

provide read/write functionality for user filtering settings.

Summary

Public Methods
UserFilter getFilter(FieldConfig fieldConfig)
Retrieve the user filter options of a custom field configuration.
void removeFilter(Long customFieldId)
Remove all the user filter options of a custom field.
void updateFilter(FieldConfig fieldConfig, UserFilter filter)
Update the user filter options of a custom field configuration.

Public Methods

public UserFilter getFilter (FieldConfig fieldConfig)

Retrieve the user filter options of a custom field configuration.

Create an empty selection with DISABLED if not found.

Parameters
fieldConfig the custom field configuration of the user filter
Returns
  • the user filter associated with the given custom field configuration

public void removeFilter (Long customFieldId)

Remove all the user filter options of a custom field.

Parameters
customFieldId the id of the custom field

public void updateFilter (FieldConfig fieldConfig, UserFilter filter)

Update the user filter options of a custom field configuration.

Parameters
fieldConfig the custom field configuration of which the user filter is to be updated
filter contains the new user filter values to be updated