SmartNXQLQueryActions (Nuxeo ECM Projects 8.10-SNAPSHOT API)

java.lang.Object
- org.nuxeo.ecm.platform.smart.query.jsf.SmartNXQLQueryActions

All Implemented Interfaces:

Serializable
```
@Name(value="smartNXQLQueryActions")
 @Scope(value=PAGE)
public class SmartNXQLQueryActions
extends Object
implements Serializable
```
Seam component handling a IncrementalSmartNXQLQuery instance created for a given existing query string.
Also handles undo/redo actions and all ajax interactions for an incremental query build page.

Since:

5.4

Author:

Anahide Tchertchian

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected IncrementalSmartNXQLQuery`	`currentSmartQuery`
`static int`	`HISTORY_CAPACITY`
`protected String`	`queryPart` Deprecated. since 8.1: query part held/set directly on the content view search document model
`protected String`	`queryPartComponentId` Request parameter making it possible to find the component holding the query part to update it.
`protected HistoryList<String>`	`queryPartHistory`
`protected HistoryList<String>`	`redoQueryPartHistory`
`protected List<SortInfo>`	`searchSortInfos` Deprecated. since 8.1: search sort infos directly held/set on the content view search document model
`protected List<String>`	`selectedLayoutColumns` Deprecated. since 8.1: selected columns directly held/set on the content view search document model
`protected Boolean`	`updateQueryPart` Deprecated. since 8.1: query part is now held by the content view search document model, consider it does not need to be updated until user clicks on "filter".

Constructor Summary

Constructors
Constructor and Description

SmartNXQLQueryActions()

Constructors
Constructor and Description
`SmartNXQLQueryActions()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`protected void`	`addToHistory(String queryPart, HistoryList<String> queryPartHistory)`
`protected void`	`addToQueryPartHistory(String queryPart)`
`void`	`buildQueryPart(javax.faces.event.ActionEvent event)` Updates the query part, asking the `currentSmartQuery` to build the new resulting query.
`void`	`clearQueryPart(javax.faces.event.ActionEvent event)` Sets the query part to an empty value.
`boolean`	`getCanRedoQueryPartChanges()`
`boolean`	`getCanUndoQueryPartChanges()`
`protected String`	`getCurrentQueryPart()`
`SmartQuery`	`getCurrentSmartQuery()`
`String`	`getQueryPart()` Deprecated. since 8.1: query part held/set directly on the content view search document model
`List<SortInfo>`	`getSearchSortInfos()` Deprecated. since 8.1: search sort infos directly held/set on the content view search document model
`List<String>`	`getSelectedLayoutColumns()` Deprecated. since 8.1: selected columns directly held/set on the content view search document model
`String`	`getWhereClause(String queryPart, boolean followedByClause)` Returns a valid where clause from a query part.
`protected boolean`	`hasQueryPartHistory(HistoryList<String> history)`
`void`	`initCurrentSmartQuery(String existingQueryPart)` Creates a new `currentSmartQuery` instance.
`void`	`initCurrentSmartQuery(String existingQueryPart, boolean resetHistory)`
`boolean`	`isAjaxRequest()` Returns true if current request is an ajax request.
`boolean`	`isInitialized()`
`void`	`queryPartChanged(javax.faces.event.AjaxBehaviorEvent event)` Updates the current `currentSmartQuery` instance according to changes on the existing query part.
`void`	`redoQueryPartChanges(javax.faces.event.ActionEvent event)`
`void`	`resetCurrentSmartQuery()`
`void`	`resetSelectedLayoutColumns()` Deprecated. since 8.1: selected columns directly held/set on the content view search document model
`protected void`	`setQueryPart(javax.faces.event.ActionEvent event, String newQuery, boolean rebuildSmartQuery)` Updates the JSF component holding the query part.
`void`	`setQueryPart(String queryPart)` Deprecated. since 8.1: query part held/set directly on the content view search document model
`void`	`setSearchSortInfos(List<SortInfo> searchSortInfos)` Deprecated. since 8.1: search sort infos directly held/set on the content view search document model
`void`	`setSelectedLayoutColumns(List<String> selectedLayoutColumns)` Deprecated. since 8.1: selected columns directly held/set on the content view search document model
`void`	`undoHistoryChanges(javax.faces.event.ActionEvent event, HistoryList<String> history, HistoryList<String> redoHistory)`
`void`	`undoQueryPartChanges(javax.faces.event.ActionEvent event)`
`void`	`validateQueryPart(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component, Object value)` Validates the query part: throws a `ValidatorException` if query is not a String, or if `IncrementalSmartNXQLQuery.isValid(String)` returns false.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - HISTORY_CAPACITY
```
public static final int HISTORY_CAPACITY
```
    See Also:
    
    Constant Field Values
  - queryPart
```
protected String queryPart
```
    Deprecated. since 8.1: query part held/set directly on the content view search document model
  - queryPartHistory
```
protected HistoryList<String> queryPartHistory
```
  - redoQueryPartHistory
```
protected HistoryList<String> redoQueryPartHistory
```
  - currentSmartQuery
```
protected IncrementalSmartNXQLQuery currentSmartQuery
```
  - selectedLayoutColumns
```
@Deprecated
protected List<String> selectedLayoutColumns
```
    Deprecated. since 8.1: selected columns directly held/set on the content view search document model
  - searchSortInfos
```
@Deprecated
protected List<SortInfo> searchSortInfos
```
    Deprecated. since 8.1: search sort infos directly held/set on the content view search document model
  - updateQueryPart
```
@RequestParameter
 @Deprecated
protected Boolean updateQueryPart
```
    Deprecated. since 8.1: query part is now held by the content view search document model, consider it does not need to be updated until user clicks on "filter".
    
    Request parameter passed from the widget that makes it possible to decide whether the backing object should be updated when performing ajax calls.
    For instance, on the smart search form, any ajax action should update the backing property queryPart. When the query part is held by a document property, it should not be updated on ajax actions: only the global submit of the form should impact it.
  - queryPartComponentId
```
@RequestParameter
protected String queryPartComponentId
```
    Request parameter making it possible to find the component holding the query part to update it.
- Constructor Detail
  - SmartNXQLQueryActions
```
public SmartNXQLQueryActions()
```
- Method Detail
  - getQueryPart
```
@Deprecated
public String getQueryPart()
```
    Deprecated. since 8.1: query part held/set directly on the content view search document model
  - setQueryPart
```
public void setQueryPart(String queryPart)
```
    Deprecated. since 8.1: query part held/set directly on the content view search document model
  - getSelectedLayoutColumns
```
@Deprecated
public List<String> getSelectedLayoutColumns()
```
    Deprecated. since 8.1: selected columns directly held/set on the content view search document model
  - setSelectedLayoutColumns
```
@Deprecated
public void setSelectedLayoutColumns(List<String> selectedLayoutColumns)
```
    Deprecated. since 8.1: selected columns directly held/set on the content view search document model
  - resetSelectedLayoutColumns
```
@Deprecated
public void resetSelectedLayoutColumns()
```
    Deprecated. since 8.1: selected columns directly held/set on the content view search document model
  - getSearchSortInfos
```
@Deprecated
public List<SortInfo> getSearchSortInfos()
```
    Deprecated. since 8.1: search sort infos directly held/set on the content view search document model
  - setSearchSortInfos
```
@Deprecated
public void setSearchSortInfos(List<SortInfo> searchSortInfos)
```
    Deprecated. since 8.1: search sort infos directly held/set on the content view search document model
  - initCurrentSmartQuery
```
public void initCurrentSmartQuery(String existingQueryPart,
                                  boolean resetHistory)
```
  - initCurrentSmartQuery
```
public void initCurrentSmartQuery(String existingQueryPart)
```
    Creates a new currentSmartQuery instance.
    This method is supposed to be called once when loading a new page: it will initialize the smart query object according to the current existing qury part.
    It should not be called when there are validation errors happening on the page, otherwise the new query part may be discarded.
  - getCurrentSmartQuery
```
public SmartQuery getCurrentSmartQuery()
```
  - queryPartChanged
```
public void queryPartChanged(javax.faces.event.AjaxBehaviorEvent event)
```
    Updates the current currentSmartQuery instance according to changes on the existing query part.
  - setQueryPart
```
protected void setQueryPart(javax.faces.event.ActionEvent event,
                            String newQuery,
                            boolean rebuildSmartQuery)
```
    Updates the JSF component holding the query part.
    
    Parameters:
    
    event - the JSF event that will give an anchor on the JSF tree to find the target component.
    
    newQuery - the new query to set.
    
    rebuildSmartQuery - if true, will rebuild the smart query completely, otherwise will just set the query part on it.
    
    Throws:
    
    NuxeoException - if target JSF component is not found in the JSF tree.
  - buildQueryPart
```
public void buildQueryPart(javax.faces.event.ActionEvent event)
```
    Updates the query part, asking the currentSmartQuery to build the new resulting query.
    
    See Also:
    
    #setQueryPart(ActionEvent, String)
  - clearQueryPart
```
public void clearQueryPart(javax.faces.event.ActionEvent event)
```
    Sets the query part to an empty value.
    
    See Also:
    
    #setQueryPart(ActionEvent, String)
  - getCurrentQueryPart
```
protected String getCurrentQueryPart()
```
  - hasQueryPartHistory
```
protected boolean hasQueryPartHistory(HistoryList<String> history)
```
  - getCanUndoQueryPartChanges
```
public boolean getCanUndoQueryPartChanges()
```
  - getCanRedoQueryPartChanges
```
public boolean getCanRedoQueryPartChanges()
```
  - undoHistoryChanges
```
public void undoHistoryChanges(javax.faces.event.ActionEvent event,
                               HistoryList<String> history,
                               HistoryList<String> redoHistory)
```
  - undoQueryPartChanges
```
public void undoQueryPartChanges(javax.faces.event.ActionEvent event)
```
  - redoQueryPartChanges
```
public void redoQueryPartChanges(javax.faces.event.ActionEvent event)
```
  - addToHistory
```
protected void addToHistory(String queryPart,
                            HistoryList<String> queryPartHistory)
```
  - addToQueryPartHistory
```
protected void addToQueryPartHistory(String queryPart)
```
  - validateQueryPart
```
public void validateQueryPart(javax.faces.context.FacesContext context,
                              javax.faces.component.UIComponent component,
                              Object value)
```
    Validates the query part: throws a ValidatorException if query is not a String, or if IncrementalSmartNXQLQuery.isValid(String) returns false.
    
    See Also:
    
    IncrementalSmartNXQLQuery.isValid(String)
  - isAjaxRequest
```
public boolean isAjaxRequest()
```
    Returns true if current request is an ajax request.
    Useful when some component should be required only when the global form is submitted, and not when ajax calls are performed.
  - getWhereClause
```
public String getWhereClause(String queryPart,
                             boolean followedByClause)
```
    Returns a valid where clause from a query part.
    Useful to avoid generating an invalid query if query part is empty (especially if content view is not marked as waiting for first execution).
    
    Since:
    
    8.1
  - isInitialized
```
public boolean isInitialized()
```
    Since:
    
    8.1
  - resetCurrentSmartQuery
```
@Observer(value="searchSelected",
          create=false)
 @BypassInterceptors
public void resetCurrentSmartQuery()
```
    Since:
    
    8.1

Class SmartNXQLQueryActions

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

HISTORY_CAPACITY

queryPart

queryPartHistory

redoQueryPartHistory

currentSmartQuery

selectedLayoutColumns

searchSortInfos

updateQueryPart

queryPartComponentId

Constructor Detail

SmartNXQLQueryActions

Method Detail

getQueryPart

setQueryPart

getSelectedLayoutColumns

setSelectedLayoutColumns

resetSelectedLayoutColumns

getSearchSortInfos

setSearchSortInfos

initCurrentSmartQuery

initCurrentSmartQuery

getCurrentSmartQuery

queryPartChanged

setQueryPart

buildQueryPart

clearQueryPart

getCurrentQueryPart

hasQueryPartHistory

getCanUndoQueryPartChanges

getCanRedoQueryPartChanges

undoHistoryChanges

undoQueryPartChanges

redoQueryPartChanges

addToHistory

addToQueryPartHistory

validateQueryPart

isAjaxRequest

getWhereClause

isInitialized

resetCurrentSmartQuery