org.nuxeo.ecm.platform.faceted.search.api.service

Interface FacetedSearchService

All Known Implementing Classes:

FacetedSearchServiceImpl

public interface FacetedSearchService

Service handling faceted searches and related saved searches.

Since:

5.4

Author:

Thomas Roger

Method Summary

Methods

Modifier and Type	Method and Description
Configuration	getConfiguration()
Set<String>	getContentViewNames() Returns the list of Content view names associated to a Faceted Search.
Set<String>	getContentViewNames(DocumentModel doc) Returns the list of Content view names associated to a Faceted Search and depending of a local configuration.
List<DocumentModel>	getCurrentUserSavedSearches(CoreSession session) Returns the current user saved Faceted Searches, located into its own user workspace.
List<DocumentModel>	getOtherUsersSavedSearches(CoreSession session) Returns all the accessible saved Faceted Searches except the ones for the current user.
DocumentModel	saveSearch(CoreSession session, ContentView facetedSearchContentView, String title) Save the current Faceted search in the user workspace with the given title.

Method Detail

getContentViewNames

Set<String> getContentViewNames()
                                throws ClientException

Returns the list of Content view names associated to a Faceted Search.

Throws:

ClientException - in case of any error

getContentViewNames

Set<String> getContentViewNames(DocumentModel doc)
                                throws ClientException

Returns the list of Content view names associated to a Faceted Search and depending of a local configuration.

Parameters:

doc - corresponds to current navigation context, to try to get some local configuration of a parent.

Throws:

ClientException - in case of any error

saveSearch

DocumentModel saveSearch(CoreSession session,
                       ContentView facetedSearchContentView,
                       String title)
                         throws ClientException

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

Parameters:

session - the CoreSession to use

facetedSearchContentView - the Faceted Search to save

title - the title of the being saved Faceted Search

Returns:

the saved Faceted Search DocumentModel

Throws:

ClientException - in case of any error during the save

getCurrentUserSavedSearches

List<DocumentModel> getCurrentUserSavedSearches(CoreSession session)
                                                throws ClientException

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

Parameters:

session - the CoreSession to use

Throws:

ClientException - in case of any error

getOtherUsersSavedSearches

List<DocumentModel> getOtherUsersSavedSearches(CoreSession session)
                                               throws ClientException

Returns all the accessible saved Faceted Searches except the ones for the current user.

Parameters:

session - the CoreSession to use

Throws:

ClientException - in case of any error

getConfiguration

Configuration getConfiguration()

Since:

5.7