com.atlassian.jira.issue.search.SearchRequestManager |
Known Indirect Subclasses |
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).
@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).
This manager is responsible for SearchRequest
s. SearchRequests encapsulate all information used for searches in the issue navigator.
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Takes a SearchRequest, user, name of search request and description and persists the XML representation
of the SearchRequest object to the database along with the rest of the details
| |||||||||||
Removes the SearchRequest GenericValue from the database based on its id
| |||||||||||
This method is deprecated.
Use
visitAll(Visitor) instead. Since v5.2.
| |||||||||||
Retrieves a collection of SearchRequest objects that a user created.
| |||||||||||
This method is deprecated.
Use
getAllOwnedSearchRequests(com.atlassian.jira.user.ApplicationUser) instead. Since v6.0.
Retrieves a collection of SearchRequest objects that a user created. | |||||||||||
Find a search request given the author and the request name.
| |||||||||||
This method is deprecated.
Use
getOwnedSearchRequestByName(com.atlassian.jira.user.ApplicationUser, String) instead. Since v6.0.
Find a search request given the author and the request name. | |||||||||||
Return the search request as stored in the database without any permission checks.
| |||||||||||
Return the search request as stored in the database if the user has permission to see it.
| |||||||||||
This method is deprecated.
Use
getSearchRequestById(com.atlassian.jira.user.ApplicationUser, Long) instead. Since v6.0.
Return the search request as stored in the database if the user has permission to see it. | |||||||||||
This method is deprecated.
Use
getSearchRequestOwner(Long) instead. Since v6.0.
Return the owner of the passed SearchRequest. This is mainly used for permission checks. | |||||||||||
Search for the SearchRequests that match the passed searchParameters.
| |||||||||||
This method is deprecated.
Use
search(com.atlassian.jira.sharing.search.SharedEntitySearchParameters, com.atlassian.jira.user.ApplicationUser, int, int) instead. Since v6.0.
Search for the SearchRequests that match the passed searchParameters. The result can be paged so that a subset
of the results can be returned. | |||||||||||
Updates an existing search request in the database.
| |||||||||||
Iterates over all SearchRequests using a Visitor pattern callback.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From interface com.atlassian.jira.sharing.SharedEntityAccessor |
Takes a SearchRequest, user, name of search request and description and persists the XML representation of the SearchRequest object to the database along with the rest of the details
request | SearchResult that should be persisted |
---|
Removes the SearchRequest GenericValue from the database based on its id
id | of the search request to be removed from storage |
---|
This method is deprecated.
Use visitAll(Visitor)
instead. Since v5.2.
Get all SearchRequests. WARNING: This method will run horribly slow on systems with a lot of saved filters.
EnclosedIterable
of SearchRequestsRetrieves a collection of SearchRequest objects that a user created.
user | The user who created the SearchRequests |
---|
SearchRequest
that user created.
This method is deprecated.
Use getAllOwnedSearchRequests(com.atlassian.jira.user.ApplicationUser)
instead. Since v6.0.
Retrieves a collection of SearchRequest objects that a user created.
user | The user who created the SearchRequests |
---|
SearchRequest
that user created.
Find a search request given the author and the request name.
author | The author of the SearchRequest |
---|---|
name | The name of the SearchRequest |
This method is deprecated.
Use getOwnedSearchRequestByName(com.atlassian.jira.user.ApplicationUser, String)
instead. Since v6.0.
Find a search request given the author and the request name.
author | The author of the SearchRequest |
---|---|
name | The name of the SearchRequest |
Return the search request as stored in the database without any permission checks.
id | The id of the filter |
---|
Return the search request as stored in the database if the user has permission to see it.
user | The user to check shares with |
---|---|
id | The id of the filter |
This method is deprecated.
Use getSearchRequestById(com.atlassian.jira.user.ApplicationUser, Long)
instead. Since v6.0.
Return the search request as stored in the database if the user has permission to see it.
user | The user to check shares with |
---|---|
id | The id of the filter |
This method is deprecated.
Use getSearchRequestOwner(Long)
instead. Since v6.0.
Return the owner of the passed SearchRequest. This is mainly used for permission checks.
id | the identifier of the SearchRequest. |
---|
Search for the SearchRequests that match the passed searchParameters. The result can be paged so that a subset of the results can be returned.
searchParameters | the searchParameters to query. |
---|---|
user | the user performing the search. |
pagePosition | the page to return. |
pageWidth | the number of results per page. |
This method is deprecated.
Use search(com.atlassian.jira.sharing.search.SharedEntitySearchParameters, com.atlassian.jira.user.ApplicationUser, int, int)
instead. Since v6.0.
Search for the SearchRequests that match the passed searchParameters. The result can be paged so that a subset
of the results can be returned.
searchParameters | the searchParameters to query. |
---|---|
user | the user performing the search. |
pagePosition | the page to return. |
pageWidth | the number of results per page. |
Updates an existing search request in the database.
request | the request to persist |
---|
SearchRequest
that was persisted to the database
Iterates over all SearchRequests using a Visitor pattern callback.