org.nuxeo.search.ui

Interface SearchUIService

All Known Implementing Classes:

SearchUIServiceImpl

public interface SearchUIService

Service handling contributed searches and related saved searches.

Since:

6.0

Method Summary

Modifier and Type	Method and Description
List<ContentViewHeader>	getContentViewHeaders(ActionContext actionContext) Returns the list of Content view headers associated to a search.
List<ContentViewHeader>	getContentViewHeaders(ActionContext actionContext, DocumentModel doc) Returns the list of Content view headers associated to a search and depending of a local configuration.
List<DocumentModel>	getCurrentUserSavedSearches(CoreSession session) Returns the current user saved searches, located into its own user workspace.
List<DocumentModel>	getSharedSavedSearches(CoreSession session) Returns all the accessible saved searches except the ones for the current user.
ContentViewState	loadSearch(DocumentModel savedSearch) Load the content view state for a given saved search.
DocumentModel	saveSearch(CoreSession session, ContentViewState searchContentViewState, String title) Save the current search in the user workspace with the given title.

Method Detail

getContentViewHeaders

List<ContentViewHeader> getContentViewHeaders(ActionContext actionContext)

Returns the list of Content view headers associated to a search.

getContentViewHeaders

List<ContentViewHeader> getContentViewHeaders(ActionContext actionContext,
                                              DocumentModel doc)

Returns the list of Content view headers associated to a search and depending of a local configuration.

saveSearch

DocumentModel saveSearch(CoreSession session,
                         ContentViewState searchContentViewState,
                         String title)

Save the current search in the user workspace with the given title.

Parameters:

session - the CoreSession to use

searchContentViewState - the search to save

title - the title of the being saved search

Returns:

the saved search DocumentModel

getCurrentUserSavedSearches

List<DocumentModel> getCurrentUserSavedSearches(CoreSession session)

Returns the current user saved searches, located into its own user workspace.

getSharedSavedSearches

List<DocumentModel> getSharedSavedSearches(CoreSession session)

Returns all the accessible saved searches except the ones for the current user.

loadSearch

ContentViewState loadSearch(DocumentModel savedSearch)

Load the content view state for a given saved search.

Since:

7.3