com.atlassian.jira.user

Interface UserFilterManager

All Known Implementing Classes:

DefaultUserFilterManager

@PublicApi
public interface UserFilterManager

provide read/write functionality for user filtering settings.

Since:

v6.2

Method Summary

Modifier and Type	Method and Description
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.

Method Detail

getFilter

UserFilter getFilter(FieldConfig fieldConfig)

Retrieve the user filter options of a custom field configuration.

Create an empty selection with UserFilter.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

updateFilter

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

removeFilter

void removeFilter(Long customFieldId)

Remove all the user filter options of a custom field.

Parameters:

customFieldId - the id of the custom field