org.nuxeo.ecm.platform.faceted.search.jsf

Class FacetedSearchActions

java.lang.Object

org.nuxeo.ecm.platform.faceted.search.jsf.FacetedSearchActions

All Implemented Interfaces:

Serializable

@Name(value="facetedSearchActions")
@Scope(value=CONVERSATION)
@Install(precedence=10)
public class FacetedSearchActions
extends Object
implements Serializable

Handles faceted search related web actions.

Since:

5.4

Author:

Thomas Roger

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	ALL_SAVED_SEARCHES_LABEL
static String	CONTENT_VIEW_NAME_PARAMETER
static String	DUBLINCORE_SCHEMA
static String	ENCODED_VALUES_ENCODING
static String	FACETED_SEARCH_CODEC
static String	FILTER_VALUES_PARAMETER
static String	FLAGGED_SAVED_SEARCHES_LABEL
static String	NONE_LABEL
static String	NONE_VALUE
static String	SEARCH_SAVED_LABEL
static String	USER_SAVED_SEARCHES_LABEL

Constructor Summary

Constructors

Constructor and Description
FacetedSearchActions()

Method Summary

Methods

Modifier and Type	Method and Description
void	clearSearch()
List<javax.faces.model.SelectItem>	getAllSavedSearchesSelectItems()
Set<ContentViewHeader>	getContentViewHeaders()
List<String>	getContentViewNames()
String	getCurrentContentViewName()
String	getCurrentSelectedSavedSearchId()
List<DocumentModel>	getCurrentUserSavedSearches()
List<DocumentModel>	getOtherUsersSavedSearches()
String	getPermanentLinkUrl() Compute a permanent link for the current search.
String	getRootSavedSearchesTitle()
String	getSavedSearchTitle()
boolean	haveOldSavedSearches()
void	invalidateContentViewsName()
void	invalidateContentViewsNameIfChanged()
void	loadSavedSearch(String savedSearchId)
void	loadSavedSearch(String contentViewName, DocumentModel searchDocument)
void	loadSelectedSavedSearch()
String	loadSelectedSavedSearch(String jsfView)
void	migrateOldSavedSearches()
void	saveSearch()
void	setCurrentContentViewName(String facetedSearchCurrentContentViewName)
void	setCurrentSelectedSavedSearchId(String savedSearchId)
void	setFilterValues(String filterValues) Set the metadata of the SearchDocumentModel from an encoded JSON string.
void	setSavedSearchTitle(String savedSearchTitle)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DUBLINCORE_SCHEMA

public static final String DUBLINCORE_SCHEMA

See Also:

Constant Field Values

NONE_VALUE

public static final String NONE_VALUE

See Also:

Constant Field Values

NONE_LABEL

public static final String NONE_LABEL

See Also:

Constant Field Values

USER_SAVED_SEARCHES_LABEL

public static final String USER_SAVED_SEARCHES_LABEL

See Also:

Constant Field Values

ALL_SAVED_SEARCHES_LABEL

public static final String ALL_SAVED_SEARCHES_LABEL

See Also:

Constant Field Values

FLAGGED_SAVED_SEARCHES_LABEL

public static final String FLAGGED_SAVED_SEARCHES_LABEL

See Also:

Constant Field Values

SEARCH_SAVED_LABEL

public static final String SEARCH_SAVED_LABEL

See Also:

Constant Field Values

FACETED_SEARCH_CODEC

public static final String FACETED_SEARCH_CODEC

See Also:

Constant Field Values

CONTENT_VIEW_NAME_PARAMETER

public static final String CONTENT_VIEW_NAME_PARAMETER

See Also:

Constant Field Values

FILTER_VALUES_PARAMETER

public static final String FILTER_VALUES_PARAMETER

See Also:

Constant Field Values

ENCODED_VALUES_ENCODING

public static final String ENCODED_VALUES_ENCODING

See Also:

Constant Field Values

Constructor Detail

FacetedSearchActions

public FacetedSearchActions()

Method Detail

getCurrentContentViewName

@Factory(value="facetedSearchCurrentContentViewName",
         scope=EVENT)
public String getCurrentContentViewName()
                                 throws ClientException

Throws:

ClientException

setCurrentContentViewName

public void setCurrentContentViewName(String facetedSearchCurrentContentViewName)

getContentViewNames

public List<String> getContentViewNames()
                                 throws ClientException

Throws:

ClientException

getContentViewHeaders

public Set<ContentViewHeader> getContentViewHeaders()
                                             throws ClientException

Throws:

ClientException

clearSearch

public void clearSearch()

getCurrentUserSavedSearches

public List<DocumentModel> getCurrentUserSavedSearches()
                                                throws ClientException

Throws:

ClientException

getOtherUsersSavedSearches

public List<DocumentModel> getOtherUsersSavedSearches()
                                               throws ClientException

Throws:

ClientException

getAllSavedSearchesSelectItems

@Factory(value="allSavedSearchesSelectItems",
         scope=EVENT)
public List<javax.faces.model.SelectItem> getAllSavedSearchesSelectItems()
                                                                  throws ClientException

Throws:

ClientException

setCurrentSelectedSavedSearchId

public void setCurrentSelectedSavedSearchId(String savedSearchId)
                                     throws ClientException

Throws:

ClientException

getCurrentSelectedSavedSearchId

public String getCurrentSelectedSavedSearchId()

loadSelectedSavedSearch

public String loadSelectedSavedSearch(String jsfView)
                               throws ClientException

Throws:

ClientException

loadSelectedSavedSearch

public void loadSelectedSavedSearch()
                             throws ClientException

Throws:

ClientException

loadSavedSearch

public void loadSavedSearch(String savedSearchId)
                     throws ClientException

Throws:

ClientException

loadSavedSearch

public void loadSavedSearch(String contentViewName,
                   DocumentModel searchDocument)
                     throws ClientException

Throws:

ClientException

getSavedSearchTitle

public String getSavedSearchTitle()

setSavedSearchTitle

public void setSavedSearchTitle(String savedSearchTitle)

saveSearch

public void saveSearch()
                throws ClientException

Throws:

ClientException

setFilterValues

public void setFilterValues(String filterValues)
                     throws ClientException,
                            org.json.JSONException,
                            UnsupportedEncodingException

Set the metadata of the SearchDocumentModel from an encoded JSON string.

Throws:

ClientException

org.json.JSONException

UnsupportedEncodingException

getPermanentLinkUrl

public String getPermanentLinkUrl()
                           throws ClientException,
                                  UnsupportedEncodingException

Compute a permanent link for the current search.

Throws:

ClientException

UnsupportedEncodingException

invalidateContentViewsName

@Observer(value="localConfigurationChanged")
public void invalidateContentViewsName()

invalidateContentViewsNameIfChanged

@Observer(value="userAllDocumentTypesSelectionChanged")
public void invalidateContentViewsNameIfChanged()
                                         throws ClientException

Throws:

ClientException

Since:

5.8

getRootSavedSearchesTitle

public String getRootSavedSearchesTitle()

haveOldSavedSearches

public boolean haveOldSavedSearches()
                             throws ClientException

Throws:

ClientException

migrateOldSavedSearches

public void migrateOldSavedSearches()
                             throws ClientException

Throws:

ClientException