com.atlassian.greenhopper.service.rapid
Interface SavedFilterService

All Known Implementing Classes:

SavedFilterServiceImpl

public interface SavedFilterService

Method Summary

boolean	canUserSeeAnySavedFilters(com.atlassian.crowd.embedded.api.User user)
ServiceOutcome<com.atlassian.jira.issue.search.SearchRequest>	createSavedFilter(com.atlassian.crowd.embedded.api.User user, java.lang.String boardName, com.atlassian.query.Query query, com.atlassian.jira.sharing.SharedEntity.SharePermissions permissions) Validate and create a new saved filter
ServiceOutcome<java.lang.Void>	deleteSavedFilter(com.atlassian.crowd.embedded.api.User user, java.lang.Long id)
ServiceOutcome<java.util.List<com.atlassian.jira.issue.search.SearchRequest>>	findSavedFilters(com.atlassian.crowd.embedded.api.User user, java.lang.String query)
ServiceOutcome<com.atlassian.jira.issue.search.SearchRequest>	getSavedFilter(com.atlassian.crowd.embedded.api.User user, java.lang.Long id)
ServiceOutcome<java.util.List<com.atlassian.jira.issue.search.SearchRequest>>	getSavedFiltersForUser(com.atlassian.crowd.embedded.api.User user) Get all saved filters for a given user.
ServiceOutcome<com.atlassian.jira.issue.search.SearchRequest>	setOrderByRank(com.atlassian.crowd.embedded.api.User user, com.atlassian.jira.issue.search.SearchRequest savedFilter) Updates the saved filter to be ordered by the rank field.
com.atlassian.jira.issue.search.SearchRequest	updateSavedFilter(com.atlassian.crowd.embedded.api.User user, ErrorCollection errors, com.atlassian.jira.issue.search.SearchRequest savedFilter)

Method Detail

getSavedFiltersForUser

@NotNull
ServiceOutcome<java.util.List<com.atlassian.jira.issue.search.SearchRequest>> getSavedFiltersForUser(com.atlassian.crowd.embedded.api.User user)

Get all saved filters for a given user. The order will be "favorites", "owned", "others"

Parameters:

user - the user

Returns:

the outcome

findSavedFilters

ServiceOutcome<java.util.List<com.atlassian.jira.issue.search.SearchRequest>> findSavedFilters(com.atlassian.crowd.embedded.api.User user,
                                                                                               java.lang.String query)

getSavedFilter

@NotNull
ServiceOutcome<com.atlassian.jira.issue.search.SearchRequest> getSavedFilter(com.atlassian.crowd.embedded.api.User user,
                                                                                     java.lang.Long id)

Returns:

the saved filter for the given user and ID, or null if it doesn't exist or the user is not allowed to see it

createSavedFilter

@NotNull
ServiceOutcome<com.atlassian.jira.issue.search.SearchRequest> createSavedFilter(com.atlassian.crowd.embedded.api.User user,
                                                                                        java.lang.String boardName,
                                                                                        com.atlassian.query.Query query,
                                                                                        com.atlassian.jira.sharing.SharedEntity.SharePermissions permissions)

Validate and create a new saved filter

Parameters:

user - the user that creates the filter

boardName - The name of the board the filter is being created for. This filter name will be derived from this

query - The JQL query to back the filter

permissions - the permission required for the filter

Returns:

the newly created saved filter - now with ID. Errors will be contained in Outcome if something went wrong.

deleteSavedFilter

ServiceOutcome<java.lang.Void> deleteSavedFilter(com.atlassian.crowd.embedded.api.User user,
                                                 java.lang.Long id)

updateSavedFilter

com.atlassian.jira.issue.search.SearchRequest updateSavedFilter(com.atlassian.crowd.embedded.api.User user,
                                                                ErrorCollection errors,
                                                                com.atlassian.jira.issue.search.SearchRequest savedFilter)

Returns:

the updated filter

setOrderByRank

ServiceOutcome<com.atlassian.jira.issue.search.SearchRequest> setOrderByRank(com.atlassian.crowd.embedded.api.User user,
                                                                             com.atlassian.jira.issue.search.SearchRequest savedFilter)

Updates the saved filter to be ordered by the rank field. All existing order by clauses will be removed.

canUserSeeAnySavedFilters

boolean canUserSeeAnySavedFilters(com.atlassian.crowd.embedded.api.User user)

Parameters:

user - : the user who can see the filters that we're looking for

Returns:

the number of filters that user can see