Nuxeo Enterprise Platform 5.4

org.nuxeo.ecm.webapp.search
Class SearchActionsBean

java.lang.Object
  extended by org.nuxeo.ecm.webapp.base.InputController
      extended by org.nuxeo.ecm.webapp.search.SearchActionsBean
All Implemented Interfaces:
java.io.Serializable, java.util.EventListener, ResultsProviderFarm, SelectDataModelListener, StatefulBaseLifeCycle, SearchActions

Deprecated. use DocumentSearchActions and content views instead

@Deprecated
@Name(value="searchActions")
@Scope(value=CONVERSATION)
public class SearchActionsBean
extends InputController
implements SearchActions, java.io.Serializable

Backing bean for search actions. Provides functions to perform a search based on different query types, to retrieve results and handle selections.

Author:
DM
See Also:
Serialized Form

Field Summary
static java.lang.String ACTION_PAGE_SEARCH_FORM
          Deprecated.  
static java.lang.String ACTION_PAGE_SEARCH_NO_KEYWORDS
          Deprecated.  
static java.lang.String ACTION_PAGE_SEARCH_QUERY_ERROR
          Deprecated.  
static java.lang.String ACTION_PAGE_SEARCH_RESULTS
          Deprecated.  
static java.lang.String PROV_NXQL
          Deprecated. 
static java.lang.String QM_ADVANCED
          Deprecated. 
static java.lang.String QM_SIMPLE
          Deprecated. 
 
Fields inherited from interface org.nuxeo.ecm.webapp.search.SearchActions
SEARCH_DOCUMENT_LIST
 
Constructor Summary
SearchActionsBean()
          Deprecated.  
 
Method Summary
 void destroy()
          Deprecated.  
 java.lang.String getDocumentLocation(DocumentModel doc)
          Deprecated.  
 DocumentModel getDocumentModel()
          Deprecated.  
 java.lang.String getLatestNxql()
          Deprecated.  
 java.lang.String getNxql()
          Deprecated.  
 java.lang.String getQueryErrorMsg()
          Deprecated.  
 java.lang.String getReindexPath()
          Deprecated.  
 java.util.List<DocumentModel> getResultDocuments(java.lang.String providerName)
          Deprecated.  
 PagedDocumentsProvider getResultsProvider(java.lang.String name)
          Deprecated. ResultsProviderFarm interface implementation.
 PagedDocumentsProvider getResultsProvider(java.lang.String name, SortInfo sortInfo)
          Deprecated.  
 SelectDataModel getResultsSelectModel(java.lang.String providerName)
          Deprecated.  
 java.lang.String getSearchTypeId()
          Deprecated.  
 java.lang.String getSimpleSearchKeywords()
          Deprecated.  
 void init()
          Deprecated. Declaration for [Seam]Create method.
 boolean isReindexingAll()
          Deprecated. Is search service reindexing all ?
 java.lang.String performSearch()
          Deprecated. To be called from UI.
 java.lang.String processSelectRow(java.lang.String selectedDocRef, java.lang.String providerName, java.lang.Boolean selection)
          Deprecated. This will be called with Seam remoting...
 void processSelectRowEvent(SelectDataModelRowEvent event)
          Deprecated.  
 void readState()
          Deprecated. Activate method.
 void refreshCache()
          Deprecated. Refresh cache
 void reindexDocuments()
          Deprecated. 
 void reindexDocuments(java.lang.String path)
          Deprecated. 
 java.lang.String reset()
          Deprecated. Reset the query fields.
 void resetSearchField()
          Deprecated.  
 void saveState()
          Deprecated. Passivate method.
 java.lang.String search()
          Deprecated. Request dispatcher.
 void setNxql(java.lang.String k)
          Deprecated.  
 void setQueryErrorMsg(java.lang.String msg)
          Deprecated.  
 void setReindexPath(java.lang.String path)
          Deprecated. Sets the current targeted reindexation path.
 void setSearchType(java.lang.String type)
          Deprecated. A page can set searchType by simply specifying a 'searchType' request parameter with value KEYWORDS or NXQL.
 void setSearchTypeId(java.lang.String type)
          Deprecated.  
 void setSimpleSearchKeywords(java.lang.String k)
          Deprecated.  
 
Methods inherited from class org.nuxeo.ecm.webapp.base.InputController
computeOutcome, getAdministrator, logDocumentWithName, logDocumentWithTitle, removeDocumentFromList
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

ACTION_PAGE_SEARCH_FORM

public static final java.lang.String ACTION_PAGE_SEARCH_FORM
Deprecated. 
See Also:
Constant Field Values

ACTION_PAGE_SEARCH_RESULTS

public static final java.lang.String ACTION_PAGE_SEARCH_RESULTS
Deprecated. 
See Also:
Constant Field Values

ACTION_PAGE_SEARCH_NO_KEYWORDS

public static final java.lang.String ACTION_PAGE_SEARCH_NO_KEYWORDS
Deprecated. 

ACTION_PAGE_SEARCH_QUERY_ERROR

public static final java.lang.String ACTION_PAGE_SEARCH_QUERY_ERROR
Deprecated. 

QM_ADVANCED

@Deprecated
public static final java.lang.String QM_ADVANCED
Deprecated. 
See Also:
Constant Field Values

QM_SIMPLE

@Deprecated
public static final java.lang.String QM_SIMPLE
Deprecated. 
See Also:
Constant Field Values

PROV_NXQL

@Deprecated
public static final java.lang.String PROV_NXQL
Deprecated. 
See Also:
Constant Field Values
Constructor Detail

SearchActionsBean

public SearchActionsBean()
Deprecated. 
Method Detail

init

public void init()
Deprecated. 
Description copied from interface: SearchActions
Declaration for [Seam]Create method.

Specified by:
init in interface SearchActions

destroy

public void destroy()
Deprecated. 
Specified by:
destroy in interface SearchActions

saveState

public void saveState()
Deprecated. 
Description copied from interface: StatefulBaseLifeCycle
Passivate method.

Specified by:
saveState in interface StatefulBaseLifeCycle

readState

public void readState()
Deprecated. 
Description copied from interface: StatefulBaseLifeCycle
Activate method.

Specified by:
readState in interface StatefulBaseLifeCycle

getSimpleSearchKeywords

@BypassInterceptors
public java.lang.String getSimpleSearchKeywords()
Deprecated. 
Specified by:
getSimpleSearchKeywords in interface SearchActions
Returns:
the query text - to be used in quick search form

setSimpleSearchKeywords

public void setSimpleSearchKeywords(java.lang.String k)
Deprecated. 
Specified by:
setSimpleSearchKeywords in interface SearchActions

getNxql

public java.lang.String getNxql()
Deprecated. 
Specified by:
getNxql in interface SearchActions
Returns:
the nxql query text if the option for nxql is selected

setNxql

public void setNxql(java.lang.String k)
Deprecated. 
Specified by:
setNxql in interface SearchActions

getSearchTypeId

@BypassInterceptors
public java.lang.String getSearchTypeId()
Deprecated. 
Specified by:
getSearchTypeId in interface SearchActions

setSearchTypeId

public void setSearchTypeId(java.lang.String type)
Deprecated. 
Specified by:
setSearchTypeId in interface SearchActions

getReindexPath

public java.lang.String getReindexPath()
Deprecated. 
Specified by:
getReindexPath in interface SearchActions
Returns:
the current targeted reindexation path

setReindexPath

public void setReindexPath(java.lang.String path)
Deprecated. 
Description copied from interface: SearchActions
Sets the current targeted reindexation path.

Specified by:
setReindexPath in interface SearchActions

setSearchType

@RequestParameter(value="searchType")
public void setSearchType(java.lang.String type)
Deprecated. 
A page can set searchType by simply specifying a 'searchType' request parameter with value KEYWORDS or NXQL.


resetSearchField

@Observer(value="userAllDocumentTypesSelectionChanged",
          create=false)
@BypassInterceptors
public void resetSearchField()
Deprecated. 
Specified by:
resetSearchField in interface SearchActions

getQueryErrorMsg

public java.lang.String getQueryErrorMsg()
Deprecated. 
Specified by:
getQueryErrorMsg in interface SearchActions

setQueryErrorMsg

public void setQueryErrorMsg(java.lang.String msg)
Deprecated. 
Specified by:
setQueryErrorMsg in interface SearchActions

search

@Begin(join=true)
public java.lang.String search()
Deprecated. 
Description copied from interface: SearchActions
Request dispatcher. Normally it will be called from a action link.

Specified by:
search in interface SearchActions

getLatestNxql

public java.lang.String getLatestNxql()
Deprecated. 
Specified by:
getLatestNxql in interface SearchActions
Returns:
the latest used NXQL query from the scope (null if none)

performSearch

public java.lang.String performSearch()
Deprecated. 
To be called from UI. Has actually only the effect of invalidating the results providers. The search perform then relies on the provider farms (including the present bean).

Specified by:
performSearch in interface SearchActions

getResultDocuments

public java.util.List<DocumentModel> getResultDocuments(java.lang.String providerName)
                                                 throws ClientException
Deprecated. 
Specified by:
getResultDocuments in interface SearchActions
Throws:
ClientException

getDocumentLocation

public java.lang.String getDocumentLocation(DocumentModel doc)
Deprecated. 
Specified by:
getDocumentLocation in interface SearchActions

getResultsSelectModel

public SelectDataModel getResultsSelectModel(java.lang.String providerName)
                                      throws ClientException
Deprecated. 
Specified by:
getResultsSelectModel in interface SearchActions
Throws:
ClientException

processSelectRow

@WebRemote
public java.lang.String processSelectRow(java.lang.String selectedDocRef,
                                                   java.lang.String providerName,
                                                   java.lang.Boolean selection)
                                  throws ClientException
Deprecated. 
Description copied from interface: SearchActions
This will be called with Seam remoting...

Specified by:
processSelectRow in interface SearchActions
Returns:
Throws:
ClientException

processSelectRowEvent

public void processSelectRowEvent(SelectDataModelRowEvent event)
Deprecated. 
Specified by:
processSelectRowEvent in interface SelectDataModelListener

getDocumentModel

@Factory(value="searchDocumentModel",
         scope=EVENT)
public DocumentModel getDocumentModel()
                               throws ClientException
Deprecated. 
Specified by:
getDocumentModel in interface SearchActions
Returns:
the Document Model backing the advanced search form up
Throws:
ClientException

reindexDocuments

@Deprecated
public void reindexDocuments()
                      throws ClientException
Deprecated. 

Description copied from interface: SearchActions
Reindex all documents.

Specified by:
reindexDocuments in interface SearchActions
Throws:
ClientException

reindexDocuments

@Deprecated
public void reindexDocuments(java.lang.String path)
                      throws ClientException
Deprecated. 

Description copied from interface: SearchActions
Reindex all documents under given path (inclusive).

Specified by:
reindexDocuments in interface SearchActions
Throws:
ClientException

reset

public java.lang.String reset()
                       throws ClientException
Deprecated. 
Description copied from interface: SearchActions
Reset the query fields.

Specified by:
reset in interface SearchActions
Returns:
Throws:
ClientException

getResultsProvider

public PagedDocumentsProvider getResultsProvider(java.lang.String name)
                                          throws ClientException,
                                                 ResultsProviderFarmUserException
Deprecated. 
ResultsProviderFarm interface implementation.

Specified by:
getResultsProvider in interface ResultsProviderFarm
Parameters:
name - the name of the ResultsProvider instance to create
Returns:
a PagedDocumentsProvider
Throws:
ClientException
ResultsProviderFarmUserException

getResultsProvider

public PagedDocumentsProvider getResultsProvider(java.lang.String name,
                                                 SortInfo sortInfo)
                                          throws ClientException,
                                                 ResultsProviderFarmUserException
Deprecated. 
Specified by:
getResultsProvider in interface ResultsProviderFarm
Parameters:
name - the name of the ResultsProvider instance to create
sortInfo - an object containing the sort details
Returns:
a PagedDocumentsProvider
Throws:
ClientException
ResultsProviderFarmUserException

refreshCache

@Observer(value="documentChildrenChanged",
          create=false)
public void refreshCache()
Deprecated. 
Description copied from interface: SearchActions
Refresh cache

Specified by:
refreshCache in interface SearchActions

isReindexingAll

public boolean isReindexingAll()
Deprecated. 
Description copied from interface: SearchActions
Is search service reindexing all ?

Specified by:
isReindexingAll in interface SearchActions
Returns:
bool flag

Nuxeo Enterprise Platform 5.4

Copyright © 2010 Nuxeo SAS. All Rights Reserved.