|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
@PublicApi public interface SearchRequestManager
This manager is responsible for SearchRequest
s. SearchRequests encapsulate all information used for searches in the issue navigator.
Nested Class Summary |
---|
Nested classes/interfaces inherited from interface com.atlassian.jira.sharing.SharedEntityAccessor |
---|
SharedEntityAccessor.Factory, SharedEntityAccessor.RetrievalDescriptor |
Method Summary | |
---|---|
SearchRequest |
create(SearchRequest request)
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 |
void |
delete(Long id)
Removes the SearchRequest GenericValue from the database based on its id |
List<SearchRequest> |
findByNameIgnoreCase(String name)
|
EnclosedIterable<SearchRequest> |
getAll()
Deprecated. Use visitAll(Visitor) instead. Since v5.2. |
Collection<SearchRequest> |
getAllOwnedSearchRequests(ApplicationUser user)
Retrieves a collection of SearchRequest objects that a user created. |
Collection<SearchRequest> |
getAllOwnedSearchRequests(com.atlassian.crowd.embedded.api.User user)
Deprecated. Use getAllOwnedSearchRequests(com.atlassian.jira.user.ApplicationUser) instead. Since v6.0.
Retrieves a collection of SearchRequest objects that a user created. |
SearchRequest |
getOwnedSearchRequestByName(ApplicationUser author,
String name)
Find a search request given the author and the request name. |
SearchRequest |
getOwnedSearchRequestByName(com.atlassian.crowd.embedded.api.User author,
String name)
Deprecated. Use getOwnedSearchRequestByName(com.atlassian.jira.user.ApplicationUser, String) instead. Since v6.0.
Find a search request given the author and the request name. |
SearchRequest |
getSearchRequestById(ApplicationUser user,
Long id)
Return the search request as stored in the database if the user has permission to see it. |
SearchRequest |
getSearchRequestById(Long id)
Return the search request as stored in the database without any permission checks. |
SearchRequest |
getSearchRequestById(com.atlassian.crowd.embedded.api.User user,
Long id)
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. |
ApplicationUser |
getSearchRequestOwner(Long id)
|
String |
getSearchRequestOwnerUserName(Long id)
Deprecated. Use getSearchRequestOwner(Long id) instead. Since v6.0.
Return the owner of the passed SearchRequest. This is mainly used for permission checks. |
SharedEntitySearchResult<SearchRequest> |
search(SharedEntitySearchParameters searchParameters,
ApplicationUser user,
int pagePosition,
int pageWidth)
Search for the SearchRequests that match the passed searchParameters. |
SharedEntitySearchResult<SearchRequest> |
search(SharedEntitySearchParameters searchParameters,
com.atlassian.crowd.embedded.api.User user,
int pagePosition,
int pageWidth)
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. |
SearchRequest |
update(SearchRequest request)
Updates an existing search request in the database. |
void |
visitAll(Visitor<SearchRequestEntity> visitor)
Iterates over all SearchRequests using a Visitor pattern callback. |
Methods inherited from interface com.atlassian.jira.sharing.SharedEntityAccessor |
---|
adjustFavouriteCount, get, get, getAllIndexableSharedEntities, getSharedEntity, getSharedEntity, getType, hasPermissionToUse |
Method Detail |
---|
Collection<SearchRequest> getAllOwnedSearchRequests(ApplicationUser user)
user
- The user who created the SearchRequests
SearchRequest
that user created.Collection<SearchRequest> getAllOwnedSearchRequests(com.atlassian.crowd.embedded.api.User user)
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.SearchRequest getOwnedSearchRequestByName(ApplicationUser author, String name)
author
- The author of the SearchRequestname
- The name of the SearchRequest
SearchRequest getOwnedSearchRequestByName(com.atlassian.crowd.embedded.api.User author, String name)
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 SearchRequestname
- The name of the SearchRequest
SearchRequest getSearchRequestById(ApplicationUser user, Long id)
user
- The user to check shares withid
- The id of the filter
getSearchRequestById(Long)
SearchRequest getSearchRequestById(com.atlassian.crowd.embedded.api.User user, Long id)
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 withid
- The id of the filter
getSearchRequestById(Long)
SearchRequest getSearchRequestById(Long id)
id
- The id of the filter
EnclosedIterable<SearchRequest> getAll()
visitAll(Visitor)
instead. Since v5.2.
getAll
in interface SharedEntityAccessor<SearchRequest>
EnclosedIterable
of SearchRequestsvoid visitAll(Visitor<SearchRequestEntity> visitor)
List<SearchRequest> findByNameIgnoreCase(String name)
String getSearchRequestOwnerUserName(Long id)
getSearchRequestOwner(Long id)
instead. Since v6.0.
Return the owner of the passed SearchRequest. This is mainly used for permission checks.
id
- the identifier of the SearchRequest.
ApplicationUser getSearchRequestOwner(Long id)
SearchRequest create(SearchRequest request)
request
- SearchResult that should be persisted
SearchRequest update(SearchRequest request)
request
- the request to persist
SearchRequest
that was persisted to the databasevoid delete(Long id)
id
- of the search request to be removed from storageSharedEntitySearchResult<SearchRequest> search(SharedEntitySearchParameters searchParameters, ApplicationUser user, int pagePosition, int pageWidth)
searchParameters
- the searchParameters to query.user
- the user performing the search.pagePosition
- the page to return.pageWidth
- the number of results per page.
SharedEntitySearchResult<SearchRequest> search(SharedEntitySearchParameters searchParameters, com.atlassian.crowd.embedded.api.User user, int pagePosition, int pageWidth)
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.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |