org.nuxeo.search.ui.seam

Class SearchUIActions

java.lang.Object

org.nuxeo.search.ui.seam.SearchUIActions

All Implemented Interfaces:

Serializable

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

Seam bean handling Search main tab actions.

Since:

6.0

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected ActionContextProvider	actionContextProvider
static String	CONTENT_VIEW_NAME_PARAMETER
static String	CONTENT_VIEW_STATE_PARAMETER
protected ContentViewActions	contentViewActions
protected List<ContentViewHeader>	contentViewHeaders
protected ContentViewService	contentViewService
static String	CURRENT_PAGE_PARAMETER
protected String	currentContentViewName
protected String	currentPage
protected String	currentSelectedSavedSearchId
static String	DEFAULT_NXQL_QUERY
protected CoreSession	documentManager
protected DocumentsListsManager	documentsListsManager
protected org.jboss.seam.faces.FacesMessages	facesMessages
static String	MAIN_TABS_SEARCH
protected Map<String,String>	messages
protected NavigationContext	navigationContext
static String	NXQL_SEARCH_CONTENT_VIEW_NAME
protected String	nxqlQuery
static String	PAGE_SIZE_PARAMETER
protected String	pageSize
protected RestHelper	restHelper
static String	SAVED_SEARCHES_LABEL
protected String	savedSearchTitle
static String	SEARCH_CODEC
static String	SEARCH_FILTERS_LABEL
static String	SEARCH_SAVED_EVENT Event name for search selection change, raised with saved document model.
static String	SEARCH_SAVED_LABEL
static String	SEARCH_SELECTED_EVENT Event name for search selection change, raised with selected corresponding content view name.
static String	SEARCH_TERM_PARAMETER
static String	SEARCH_VIEW_ID
protected String	searchTerm
static String	SHARED_SEARCHES_LABEL
static String	SIMPLE_SEARCH_CONTENT_VIEW_NAME
protected String	simpleSearchKeywords
protected WebActions	webActions

Constructor Summary

Constructors

Constructor and Description
SearchUIActions()

Method Summary

Modifier and Type	Method and Description
void	cancelSaveSearch()
void	clearSearch()
protected DocumentView	computeDocumentView(DocumentModel doc)
protected List<javax.faces.model.SelectItem>	convertCVToSelectItems(List<ContentViewHeader> contentViewHeaders)
protected List<javax.faces.model.SelectItem>	convertToSelectItems(List<DocumentModel> docs)
String	doSimpleSearch()
protected String	generateSearchUrl(boolean withState) Create the url to access the Search tab.
List<javax.faces.model.SelectItem>	getAllSavedSearchesSelectItems()
boolean	getCanSaveSearch() Retsurns true if current search can be saved.
List<ContentViewHeader>	getContentViewHeaders()
String	getCurrentContentViewName()
String	getCurrentPage()
String	getCurrentSelectedSavedSearchId()
String	getJSONContentViewState()
String	getNxqlQuery()
String	getPageSize()
protected List<DocumentModel>	getSavedSearches()
String	getSavedSearchTitle()
String	getSearchMainTab()
String	getSearchPermanentLinkUrl() Compute a permanent link for the current search.
String	getSearchTabUrl(String searchTerm)
String	getSearchTermParameter()
String	getSearchViewTitle()
protected List<DocumentModel>	getSharedSearches()
String	getSimpleSearchKeywords()
void	invalidateContentViewsName()
void	invalidateContentViewsNameIfChanged()
boolean	isNxqlSearchSelected()
boolean	isOnSearchView() Returns true if the user is viewing SEARCH.
String	loadPermanentLink(DocumentView docView)
void	loadSavedSearch(DocumentModel searchDocument)
void	onSearchSaved() Triggers content view refresh/reset on saved search.
void	refreshAndRewind()
void	refreshAndRewindAndResetAggregates()
protected void	resetCurrentContentViewWorkingList()
void	resetOnFlush() Reset attributes.
String	saveSearch()
void	setCurrentContentViewName(String contentViewName)
void	setCurrentPage(String currentPage)
void	setCurrentSelectedSavedSearchId(String selectedSavedSearchId)
void	setNxqlQuery(String nxqlQuery)
void	setPageSize(String pageSize)
void	setSavedSearchTitle(String savedSearchTitle)
void	setSearchMainTab(String tabs)
void	setSearchTerm(String searchTerm)
void	setSimpleSearchKeywords(String simpleSearchKeywords)
void	setState(String state)
void	validateSimpleSearchKeywords(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component, Object value)

Methods inherited from class java.lang.Object

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

Field Detail

SAVED_SEARCHES_LABEL

public static final String SAVED_SEARCHES_LABEL

See Also:

Constant Field Values

SHARED_SEARCHES_LABEL

public static final String SHARED_SEARCHES_LABEL

See Also:

Constant Field Values

SEARCH_FILTERS_LABEL

public static final String SEARCH_FILTERS_LABEL

See Also:

Constant Field Values

SEARCH_SAVED_LABEL

public static final String SEARCH_SAVED_LABEL

See Also:

Constant Field Values

MAIN_TABS_SEARCH

public static final String MAIN_TABS_SEARCH

See Also:

Constant Field Values

SEARCH_VIEW_ID

public static final String SEARCH_VIEW_ID

See Also:

Constant Field Values

SEARCH_CODEC

public static final String SEARCH_CODEC

See Also:

Constant Field Values

SIMPLE_SEARCH_CONTENT_VIEW_NAME

public static final String SIMPLE_SEARCH_CONTENT_VIEW_NAME

See Also:

Constant Field Values

NXQL_SEARCH_CONTENT_VIEW_NAME

public static final String NXQL_SEARCH_CONTENT_VIEW_NAME

See Also:

Constant Field Values

DEFAULT_NXQL_QUERY

public static final String DEFAULT_NXQL_QUERY

See Also:

Constant Field Values

CONTENT_VIEW_NAME_PARAMETER

public static final String CONTENT_VIEW_NAME_PARAMETER

See Also:

Constant Field Values

CURRENT_PAGE_PARAMETER

public static final String CURRENT_PAGE_PARAMETER

See Also:

Constant Field Values

PAGE_SIZE_PARAMETER

public static final String PAGE_SIZE_PARAMETER

See Also:

Constant Field Values

CONTENT_VIEW_STATE_PARAMETER

public static final String CONTENT_VIEW_STATE_PARAMETER

See Also:

Constant Field Values

SEARCH_TERM_PARAMETER

public static final String SEARCH_TERM_PARAMETER

See Also:

Constant Field Values

SEARCH_SELECTED_EVENT

public static final String SEARCH_SELECTED_EVENT

Event name for search selection change, raised with selected corresponding content view name.

Since:

8.1

See Also:

Constant Field Values

SEARCH_SAVED_EVENT

public static final String SEARCH_SAVED_EVENT

Event name for search selection change, raised with saved document model.

Since:

8.1

See Also:

Constant Field Values

navigationContext

@In(create=true)
protected transient NavigationContext navigationContext

documentManager

@In(create=true,
    required=false)
protected transient CoreSession documentManager

actionContextProvider

@In(create=true,
    required=false)
protected transient ActionContextProvider actionContextProvider

webActions

@In(create=true)
protected transient WebActions webActions

restHelper

@In(create=true)
protected RestHelper restHelper

contentViewActions

@In(create=true)
protected ContentViewActions contentViewActions

contentViewService

@In(create=true)
protected ContentViewService contentViewService

documentsListsManager

@In(create=true)
protected DocumentsListsManager documentsListsManager

facesMessages

@In(create=true,
    required=false)
protected org.jboss.seam.faces.FacesMessages facesMessages

messages

@In(create=true)
protected Map<String,String> messages

simpleSearchKeywords

protected String simpleSearchKeywords

nxqlQuery

protected String nxqlQuery

contentViewHeaders

protected List<ContentViewHeader> contentViewHeaders

currentContentViewName

protected String currentContentViewName

currentSelectedSavedSearchId

protected String currentSelectedSavedSearchId

currentPage

protected String currentPage

pageSize

protected String pageSize

searchTerm

protected String searchTerm

savedSearchTitle

protected String savedSearchTitle

Constructor Detail

SearchUIActions

public SearchUIActions()

Method Detail

getSearchMainTab

public String getSearchMainTab()

setSearchMainTab

public void setSearchMainTab(String tabs)

getSearchViewTitle

public String getSearchViewTitle()

isOnSearchView

public boolean isOnSearchView()

Returns true if the user is viewing SEARCH.

getJSONContentViewState

public String getJSONContentViewState()
                               throws IOException

Throws:

IOException

getCurrentContentViewName

public String getCurrentContentViewName()

setCurrentContentViewName

public void setCurrentContentViewName(String contentViewName)

getCurrentSelectedSavedSearchId

public String getCurrentSelectedSavedSearchId()

setCurrentSelectedSavedSearchId

public void setCurrentSelectedSavedSearchId(String selectedSavedSearchId)
                                     throws UnsupportedEncodingException

Throws:

UnsupportedEncodingException

resetCurrentContentViewWorkingList

protected void resetCurrentContentViewWorkingList()

loadSavedSearch

public void loadSavedSearch(DocumentModel searchDocument)
                     throws UnsupportedEncodingException

Throws:

UnsupportedEncodingException

getContentViewHeaders

public List<ContentViewHeader> getContentViewHeaders()

clearSearch

public void clearSearch()

refreshAndRewind

public void refreshAndRewind()

refreshAndRewindAndResetAggregates

public void refreshAndRewindAndResetAggregates()

getAllSavedSearchesSelectItems

public List<javax.faces.model.SelectItem> getAllSavedSearchesSelectItems()

getSavedSearches

protected List<DocumentModel> getSavedSearches()

getSharedSearches

protected List<DocumentModel> getSharedSearches()

convertToSelectItems

protected List<javax.faces.model.SelectItem> convertToSelectItems(List<DocumentModel> docs)

convertCVToSelectItems

protected List<javax.faces.model.SelectItem> convertCVToSelectItems(List<ContentViewHeader> contentViewHeaders)

getSavedSearchTitle

public String getSavedSearchTitle()

setSavedSearchTitle

public void setSavedSearchTitle(String savedSearchTitle)

saveSearch

public String saveSearch()

getCanSaveSearch

public boolean getCanSaveSearch()

Retsurns true if current search can be saved.

Returns false if current content view is waiting for a first execution.

Since:

7.4

cancelSaveSearch

public void cancelSaveSearch()

setState

public void setState(String state)
              throws IOException

Throws:

IOException

getCurrentPage

public String getCurrentPage()

setCurrentPage

public void setCurrentPage(String currentPage)

getPageSize

public String getPageSize()

setPageSize

public void setPageSize(String pageSize)

setSearchTerm

public void setSearchTerm(String searchTerm)
                   throws UnsupportedEncodingException

Throws:

UnsupportedEncodingException

getSearchPermanentLinkUrl

public String getSearchPermanentLinkUrl()
                                 throws IOException

Compute a permanent link for the current search.

Throws:

IOException

getSearchTabUrl

public String getSearchTabUrl(String searchTerm)
                       throws IOException

Returns:

the URL of the search tab with the search term defined.

Throws:

IOException

generateSearchUrl

protected String generateSearchUrl(boolean withState)
                            throws IOException

Create the url to access the Search tab.

Parameters:

withState - If set to true, the state is added in the parameters.

Throws:

IOException

computeDocumentView

protected DocumentView computeDocumentView(DocumentModel doc)

getSimpleSearchKeywords

public String getSimpleSearchKeywords()

setSimpleSearchKeywords

public void setSimpleSearchKeywords(String simpleSearchKeywords)

validateSimpleSearchKeywords

public void validateSimpleSearchKeywords(javax.faces.context.FacesContext context,
                                         javax.faces.component.UIComponent component,
                                         Object value)

doSimpleSearch

public String doSimpleSearch()

getNxqlQuery

public String getNxqlQuery()

setNxqlQuery

public void setNxqlQuery(String nxqlQuery)

isNxqlSearchSelected

public boolean isNxqlSearchSelected()

loadPermanentLink

@Begin(id="#{conversationIdGenerator.currentOrNewMainConversationId}",
       join=true)
public String loadPermanentLink(DocumentView docView)

invalidateContentViewsName

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

invalidateContentViewsNameIfChanged

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

resetOnFlush

@Observer(value="flush",
          create=false)
 @BypassInterceptors
public void resetOnFlush()

Reset attributes.

getSearchTermParameter

public String getSearchTermParameter()

onSearchSaved

@Observer(value="searchSaved")
public void onSearchSaved()

Triggers content view refresh/reset on saved search.

Since:

8.1