com.atlassian.jira.rest.v2.search

Class FilterResource

java.lang.Object

com.atlassian.jira.rest.v2.search.FilterResource

public class FilterResource
extends Object

Resource for searches.

Since:

v5.0

Constructor Summary

Constructors

Constructor and Description

FilterResource(JiraAuthenticationContext authenticationContext, SearchRequestService searchRequestService, VelocityRequestContextFactory velocityRequestContextFactory, FavouritesService favouritesService, SearchService searchService, BeanBuilderFactory beanBuilderFactory, UserSharingPreferencesUtil userSharingPreferencesUtil, PermissionManager permissionsManager, UserPreferencesManager userPreferencesManager, ColumnLayoutManager columnLayoutManager, ColumnService columnService, FilterPermissionBeanFactory filterPermissionBeanFactory, ResponseFactory responseFactory, SharePermissionFactory sharePermissionFactory, FilterPermissionHelper filterPermissionHelper, MauEventService mauEventService)

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	addSharePermission(SharePermissionInputBean sharePermissionInputBean, Long id) Adds a share permissions to the given filter.
javax.ws.rs.core.Response	createFilter(FilterBean bean, javax.ws.rs.core.UriInfo uriInfo, StringList expand) Creates a new filter, and returns newly created filter.
javax.ws.rs.core.Response	defaultColumns(Long filterId) Returns the default columns for the given filter.
javax.ws.rs.core.Response	deleteFilter(Long id) Delete a filter.
javax.ws.rs.core.Response	deleteSharePermission(Long id, Long permissionId) Removes a share permissions from the given filter.
javax.ws.rs.core.Response	editFilter(Long filterId, FilterBean bean, javax.ws.rs.core.UriInfo uriInfo, StringList expand) Updates an existing filter, and returns its new value.
javax.ws.rs.core.Response	getDefaultShareScope() Returns the default share scope of the logged-in user.
List<FilterBean>	getFavouriteFilters(javax.ws.rs.core.UriInfo uriInfo, StringList expand, boolean enableSharedUsers) Returns the favourite filters of the logged-in user.
javax.ws.rs.core.Response	getFilter(Long id, javax.ws.rs.core.UriInfo uriInfo, StringList expand, boolean enableSharedUsers) Returns a filter given an id
javax.ws.rs.core.Response	getSharePermission(Long id, Long permissionId) Returns a single share permission of the given filter.
javax.ws.rs.core.Response	getSharePermissions(Long id) Returns all share permissions of the given filter.
javax.ws.rs.core.Response	resetColumns(Long filterId) Resets the columns for the given filter such that the filter no longer has its own column config.
javax.ws.rs.core.Response	setColumns(Long filterId, List<String> fields) Sets the default columns for the given filter.
javax.ws.rs.core.Response	setDefaultShareScope(DefaultShareScopeBean shareScope) Sets the default share scope of the logged-in user.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FilterResource

public FilterResource(JiraAuthenticationContext authenticationContext,
                      SearchRequestService searchRequestService,
                      VelocityRequestContextFactory velocityRequestContextFactory,
                      FavouritesService favouritesService,
                      SearchService searchService,
                      BeanBuilderFactory beanBuilderFactory,
                      UserSharingPreferencesUtil userSharingPreferencesUtil,
                      PermissionManager permissionsManager,
                      UserPreferencesManager userPreferencesManager,
                      ColumnLayoutManager columnLayoutManager,
                      ColumnService columnService,
                      FilterPermissionBeanFactory filterPermissionBeanFactory,
                      ResponseFactory responseFactory,
                      SharePermissionFactory sharePermissionFactory,
                      FilterPermissionHelper filterPermissionHelper,
                      MauEventService mauEventService)

Method Detail

getFilter

public javax.ws.rs.core.Response getFilter(Long id,
                                           @Context
                                           javax.ws.rs.core.UriInfo uriInfo,
                                           StringList expand,
                                           boolean enableSharedUsers)

Returns a filter given an id

Parameters:

id - the id of the filter being looked up

uriInfo - info needed to construct URLs.

expand - the parameters to expand

enableSharedUsers - enable calculating shared users collection

Returns:

a FilterBean

createFilter

public javax.ws.rs.core.Response createFilter(FilterBean bean,
                                              @Context
                                              javax.ws.rs.core.UriInfo uriInfo,
                                              StringList expand)

Creates a new filter, and returns newly created filter. Currently sets permissions just using the users default sharing permissions

Parameters:

bean - the filter being created

uriInfo - info needed to construct URLs.

expand - the parameters to expand

Returns:

a FilterBean

editFilter

public javax.ws.rs.core.Response editFilter(Long filterId,
                                            FilterBean bean,
                                            @Context
                                            javax.ws.rs.core.UriInfo uriInfo,
                                            StringList expand)

Updates an existing filter, and returns its new value.

Parameters:

filterId - the id of the filter to update

bean - the filter being created

uriInfo - info needed to construct URLs.

expand - the parameters to expand

Returns:

a FilterBean

deleteFilter

public javax.ws.rs.core.Response deleteFilter(Long id)

Delete a filter.

Parameters:

id - The ID of the filter to delete.

Returns:

a 204 HTTP status if everything goes well

getFavouriteFilters

public List<FilterBean> getFavouriteFilters(@Context
                                            javax.ws.rs.core.UriInfo uriInfo,
                                            StringList expand,
                                            boolean enableSharedUsers)

Returns the favourite filters of the logged-in user.

Parameters:

uriInfo - info needed to construct URLs.

expand - the parameters to expand

enableSharedUsers - enable calculating shared users collection

Returns:

a List of FilterBean

getDefaultShareScope

public javax.ws.rs.core.Response getDefaultShareScope()

Returns the default share scope of the logged-in user.

Returns:

a DefaultShareScopeBean

setDefaultShareScope

public javax.ws.rs.core.Response setDefaultShareScope(DefaultShareScopeBean shareScope)

Sets the default share scope of the logged-in user. Available values are GLOBAL and PRIVATE.

Returns:

a DefaultShareScopeBean

defaultColumns

public javax.ws.rs.core.Response defaultColumns(Long filterId)

Returns the default columns for the given filter. Currently logged in user will be used as the user making such request.

Parameters:

filterId - id of the filter

Returns:

column configuration

Since:

v6.1

setColumns

public javax.ws.rs.core.Response setColumns(Long filterId,
                                            List<String> fields)

Sets the default columns for the given filter.

Parameters:

filterId - id of the filter

fields - list of column ids

Returns:

javax.ws.rs.core.Response containing basic message and http return code

Since:

v6.1

resetColumns

public javax.ws.rs.core.Response resetColumns(Long filterId)

Resets the columns for the given filter such that the filter no longer has its own column config.

Parameters:

filterId - id of the filter

Returns:

javax.ws.rs.core.Response containing basic message and http return code

Since:

v6.1

getSharePermissions

public javax.ws.rs.core.Response getSharePermissions(Long id)

Returns all share permissions of the given filter.

Returns:

a list of share permissions associated with the given filter.

getSharePermission

public javax.ws.rs.core.Response getSharePermission(Long id,
                                                    Long permissionId)

Returns a single share permission of the given filter.

Returns:

a a share permission associated with the given filter and permission-id.

addSharePermission

public javax.ws.rs.core.Response addSharePermission(SharePermissionInputBean sharePermissionInputBean,
                                                    Long id)

Adds a share permissions to the given filter. Adding a global permission removes all previous permissions from the filter.

Returns:

share permissions associated with the given filter

deleteSharePermission

public javax.ws.rs.core.Response deleteSharePermission(Long id,
                                                       Long permissionId)

Removes a share permissions from the given filter.