|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface SearchRequestManager
This manager is reponsible for SearchRequest
s. SearchRequests
encapsulate all information used for searches in the issue navigator.
Method Summary | |
---|---|
SearchRequest |
create(SearchRequest oldSearchRequest,
User searchUser,
FieldValuesHolder params,
SearchContext searchContext)
Takes a user and a FieldValuesHolder of parameters that are used to create a object representation of
the search request. |
void |
createSearchSorts(SearchRequest searchRequest,
Map params)
Adds SearchSort parameters to the searchRequest, to specify ordering and sorting of
results. |
SearchRequest |
getRequest(User searcher,
Long id)
Find a search request given the searcher and the search request ID. |
SearchRequest |
getRequest(User author,
String name,
User searcher)
Find a search request given the author and the request name. |
List |
getRequests()
Retrieves all the SearchRequest GenericValues |
Collection |
getRequests(User author)
Retrieves all the SearchRequest GenericValues from a particular user |
SearchRequest |
getSearchRequest(User searcher,
Long id)
Return the search request as stored in the database |
SearchRequest |
getSearchRequestWithSearchSorts(Map parameterMap,
User searchUser)
Takes a user and a Map of request parameters that are used to create a object representation of the search request. |
List |
getVisibleRequests(User user)
Return a list of all search requests visible to a given user. |
boolean |
isRequestPrivate(User searcher,
Long id)
Determine whether the search request is a private filter to the searcher |
void |
remove(Long id)
Removes the SearchRequest GenericValue from the database based on its id |
void |
removeAllFilters(org.ofbiz.core.entity.GenericValue project)
Remove all filters related to a particular project. |
void |
removeAllFilters(User author)
Remove all filters owned by a particular author. |
org.ofbiz.core.entity.GenericValue |
save(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 |
org.ofbiz.core.entity.GenericValue |
update(SearchRequest request)
Updates an existing search request in the database. |
Method Detail |
---|
SearchRequest create(SearchRequest oldSearchRequest, User searchUser, FieldValuesHolder params, SearchContext searchContext)
FieldValuesHolder
of parameters that are used to create a object representation of
the search request.
searchUser
- The user that is searchingparams
- parameters to search for. Must not be nullsearchContext
- the search context. Used to determined available searchers. If it's null, a Global search context will be usedSearchRequest getSearchRequestWithSearchSorts(Map parameterMap, User searchUser)
parameterMap
- Generally this will be obtained by calling ServletRequest.getParameterMap()
searchUser
- The user that is searching
void createSearchSorts(SearchRequest searchRequest, Map params)
SearchSort
parameters to the searchRequest, to specify ordering and sorting of
results.
searchRequest
- params
- List getRequests() throws org.ofbiz.core.entity.GenericEntityException
org.ofbiz.core.entity.GenericEntityException
Collection getRequests(User author)
author
- to retrieve all the SearchRequests for
getVisibleRequests(com.opensymphony.user.User)
SearchRequest getRequest(User author, String name, User searcher) throws org.ofbiz.core.entity.GenericEntityException
org.ofbiz.core.entity.GenericEntityException
- If any exceptions occur finding the requestSearchRequest getRequest(User searcher, Long id)
DataAccessException
- If any exceptions occur finding the requestSearchRequest getSearchRequest(User searcher, Long id)
boolean isRequestPrivate(User searcher, Long id)
List getVisibleRequests(User user) throws org.ofbiz.core.entity.GenericEntityException
user
- The user to find search requests for
org.ofbiz.core.entity.GenericEntityException
org.ofbiz.core.entity.GenericValue save(SearchRequest request) throws org.ofbiz.core.entity.GenericEntityException
request
- SearchResult that should be persisted
org.ofbiz.core.entity.GenericEntityException
org.ofbiz.core.entity.GenericValue update(SearchRequest request) throws org.ofbiz.core.entity.GenericEntityException
request
-
GenericValue
object that was persisted to the database
org.ofbiz.core.entity.GenericEntityException
void remove(Long id) throws SearchException
id
- of the search request to be removed from storage
SearchException
void removeAllFilters(User author) throws SearchException
author
-
SearchException
void removeAllFilters(org.ofbiz.core.entity.GenericValue project) throws SearchException
project
-
SearchException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |