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

Methods

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.
DocumentModel	saveSearch(CoreSession session, ContentView searchContentView, 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,
                       ContentView searchContentView,
                       String title)
                         throws ClientException

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

Parameters:

session - the CoreSession to use

searchContentView - the search to save

title - the title of the being saved search

Returns:

the saved search DocumentModel

Throws:

ClientException

getCurrentUserSavedSearches

List<DocumentModel> getCurrentUserSavedSearches(CoreSession session)
                                                throws ClientException

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

Throws:

ClientException

getSharedSavedSearches

List<DocumentModel> getSharedSavedSearches(CoreSession session)
                                           throws ClientException

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

Throws:

ClientException