|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.atlassian.jira.issue.search.DefaultSearchRequestManager
public class DefaultSearchRequestManager
Nested Class Summary |
---|
Nested classes/interfaces inherited from interface com.atlassian.jira.sharing.SharedEntityAccessor |
---|
SharedEntityAccessor.Factory, SharedEntityAccessor.RetrievalDescriptor |
Constructor Summary | |
---|---|
DefaultSearchRequestManager(ColumnLayoutManager columnLayoutManager,
SubscriptionManager subscriptionManager,
ShareManager shareManager,
SearchRequestStore searchRequestStore,
SharedEntityIndexer indexer)
|
Method Summary | |
---|---|
void |
adjustFavouriteCount(SharedEntity entity,
int adjustmentValue)
Adjusts the favourite counts for a given entity. |
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 |
CloseableIterable |
get(SharedEntityAccessor.RetrievalDescriptor descriptor)
Used to get sharable entities from a search result. |
CloseableIterable |
getAll()
Get all sharable entities this accessor can see. |
Collection |
getAllOwnedSearchRequests(User user)
Retrieves a collection of SearchRequest objects that a user created. |
SearchRequest |
getOwnedSearchRequestByName(User author,
String name)
Find a search request given the author and the request name. |
SearchRequest |
getRequest(User searcher,
Long id)
Find a search request given the searcher and the search request ID. |
List |
getRequests()
Deprecated. v3.13 Put in for backwards compatibility |
Collection |
getRequests(User author)
Deprecated. v3.13 Put in for backwards compatibility |
SearchRequest |
getSearchRequest(User searcher,
Long id)
Find a search request given the searcher and the search request ID. |
SearchRequest |
getSearchRequestById(Long id)
|
SearchRequest |
getSearchRequestById(User user,
Long id)
Return the search request as stored in the database |
String |
getSearchRequestOwnerUserName(Long id)
Return the owner of the passed SearchRequest. |
SharedEntity |
getSharedEntity(Long entityId)
This will call back to ask for a SharedEntity based on id. |
SharedEntity |
getSharedEntity(User user,
Long entityId)
This is called to get SharedEntity by id If the user is allows to see it |
SharedEntity.TypeDescriptor |
getType()
Returns the type that this object can work with. |
List |
getVisibleRequests(User user)
Return a list of all search requests visible to a given user. |
boolean |
hasPermissionToUse(User user,
SharedEntity entity)
Returns true if the user has permission to use the SharedEntity |
SharedEntitySearchResult |
search(SharedEntitySearchParameters searchParameters,
User user,
int pagePosition,
int pageWidth)
Search for the SearchRequests that match the passed searchParameters. |
SearchRequest |
update(SearchRequest request)
Updates an existing search request in the database. |
void |
validateSearchRequestUpdate(SearchRequest request)
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public DefaultSearchRequestManager(ColumnLayoutManager columnLayoutManager, SubscriptionManager subscriptionManager, ShareManager shareManager, SearchRequestStore searchRequestStore, SharedEntityIndexer indexer)
Method Detail |
---|
public CloseableIterable get(SharedEntityAccessor.RetrievalDescriptor descriptor)
SharedEntityAccessor
sharable entities
from a search result.
get
in interface SharedEntityAccessor
descriptor
- retrieval descriptor
CloseableIterable
of SharedEntity
'spublic CloseableIterable getAll()
SharedEntityAccessor
sharable entities
this accessor can see.
getAll
in interface SharedEntityAccessor
CloseableIterable
of SharedEntity
'spublic Collection getAllOwnedSearchRequests(User user)
SearchRequestManager
getAllOwnedSearchRequests
in interface SearchRequestManager
user
- The user who created the SearchRequests
SearchRequest
that user created.public SearchRequest getOwnedSearchRequestByName(User author, String name)
SearchRequestManager
getOwnedSearchRequestByName
in interface SearchRequestManager
author
- The author of the SearchRequestname
- The name of the SearchRequest
public SearchRequest getSearchRequestById(Long id)
public SearchRequest getSearchRequestById(User user, Long id)
SearchRequestManager
getSearchRequestById
in interface SearchRequestManager
user
- The user to check shares withid
- The id of the filter
public String getSearchRequestOwnerUserName(Long id)
SearchRequestManager
getSearchRequestOwnerUserName
in interface SearchRequestManager
id
- the identifier of the SearchRequest.
public SearchRequest create(SearchRequest request)
SearchRequestManager
create
in interface SearchRequestManager
request
- SearchResult that should be persisted
public SearchRequest update(SearchRequest request)
SearchRequestManager
update
in interface SearchRequestManager
request
- the request to persist
SearchRequest
that was persisted to the databasepublic void delete(Long id)
SearchRequestManager
delete
in interface SearchRequestManager
id
- of the search request to be removed from storagepublic SharedEntity.TypeDescriptor getType()
SharedEntityAccessor
getType
in interface SharedEntityAccessor
public void adjustFavouriteCount(SharedEntity entity, int adjustmentValue)
SharedEntityAccessor
adjustFavouriteCount
in interface SharedEntityAccessor
entity
- the entity to adjustadjustmentValue
- the value to adjust by.public void validateSearchRequestUpdate(SearchRequest request)
public List getVisibleRequests(User user)
SearchRequestManager
getVisibleRequests
in interface SearchRequestManager
user
- The user to find search requests for
public SearchRequest getRequest(User searcher, Long id)
SearchRequestManager
getRequest
in interface SearchRequestManager
searcher
- The user to check permissions for.id
- The id of the SearchRequest
public SearchRequest getSearchRequest(User searcher, Long id)
SearchRequestManager
getSearchRequest
in interface SearchRequestManager
searcher
- The user to check permissions for.id
- The id of the SearchRequest
public List getRequests() throws org.ofbiz.core.entity.GenericEntityException
SearchRequestManager
getRequests
in interface SearchRequestManager
org.ofbiz.core.entity.GenericEntityException
- thrown if error occurs in databasepublic Collection getRequests(User author)
SearchRequestManager
getRequests
in interface SearchRequestManager
author
- to retrieve all the SearchRequests for
public SharedEntitySearchResult search(SharedEntitySearchParameters searchParameters, User user, int pagePosition, int pageWidth)
SearchRequestManager
search
in interface SearchRequestManager
searchParameters
- the searchParameters to query.user
- the user performing the search.pagePosition
- the page to return.pageWidth
- the number of results per page.
public SharedEntity getSharedEntity(Long entityId)
SharedEntityAccessor
SharedEntity
based on id.
getSharedEntity
in interface SharedEntityAccessor
entityId
- the id of the SharedEntity
SharedEntity
or null if it cant be foundpublic SharedEntity getSharedEntity(User user, Long entityId)
SharedEntityAccessor
SharedEntity
by id If the user is allows to see it
getSharedEntity
in interface SharedEntityAccessor
user
- the user in playentityId
- the id of the SharedEntity
SharedEntity
if it exists and the user can see it and null otherwisepublic boolean hasPermissionToUse(User user, SharedEntity entity)
SharedEntityAccessor
SharedEntity
hasPermissionToUse
in interface SharedEntityAccessor
user
- the user in playentity
- the SharedEntity
to check
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |