com.atlassian.bamboo.quickfilter

Interface UserActiveQuickFilterService

All Known Implementing Classes:

UserActiveQuickFilterServiceImpl

@ThreadSafe
public interface UserActiveQuickFilterService

A service for managing active quick filters for users. Active filters are used to limit plans on user's dashboard. Each user can have multiple quick filters active at a time.

Method Summary

Modifier and Type	Method and Description
void	activateQuickFilter(com.atlassian.user.User user, long quickFilterId) Activates a quick filter for a user
void	deactivateAllQuickFilters(com.atlassian.user.User user) Deactivates all quick filters for a user
void	deactivateQuickFilter(com.atlassian.user.User user, long quickFilterId) Deactivates a quick filter for a user
List<QuickFilter>	getActiveQuickFilters(com.atlassian.user.User user) Returns all active quick filters for a user

Method Detail

getActiveQuickFilters

@NotNull
List<QuickFilter> getActiveQuickFilters(@NotNull
                                                 com.atlassian.user.User user)

Returns all active quick filters for a user

Parameters:

user - Bamboo user

Returns:

a list of all quick filters that are active for that user; might be an empty list

activateQuickFilter

void activateQuickFilter(@NotNull
                         com.atlassian.user.User user,
                         long quickFilterId)

Activates a quick filter for a user

Parameters:

user - Bamboo user

quickFilterId - id of the quick filter to set active

deactivateQuickFilter

void deactivateQuickFilter(@NotNull
                           com.atlassian.user.User user,
                           long quickFilterId)

Deactivates a quick filter for a user

Parameters:

user - Bamboo user

quickFilterId - id of the quick filter to deactivate

deactivateAllQuickFilters

void deactivateAllQuickFilters(@NotNull
                               com.atlassian.user.User user)

Deactivates all quick filters for a user

Parameters:

user - Bamboo user