org.nuxeo.ecm.webapp.querymodel

Interface QueryModelActions

All Superinterfaces:

ResultsProviderFarm

All Known Implementing Classes:

QueryModelActionsBean

Deprecated.

since 5.4: use ContentViewActions instead

@Deprecated
public interface QueryModelActions
extends ResultsProviderFarm

Action listener dedicated to the session management QueryModels.

QueryModels are non persistent structures to build advanced NXQueries by incrementally editing fields of a model that will be translated into search criteria once the search is actually performed.

This bean extends ResultsProviderFarm for stateful Query Models only. Stateless models have to be handled by \] another farm, which typically would still call the present bean to get the QueryModel instance.

Author:

Olivier Grisel (ogrisel@nuxeo.com)

Method Summary

Methods

Modifier and Type	Method and Description
QueryModel	get(String queryModelName) Deprecated. Obtain a scoped instance of QueryModel.
boolean	isInitialized() Deprecated.
boolean	isPersisted(String queryModelName) Deprecated. Tell if the DocumentModel behind the specified QueryModel has been persisted in Nuxeo Core.
QueryModel	load(String queryModelName, DocumentRef ref) Deprecated. Load a stateful QueryModel from the specified DocumentRef.
QueryModel	persist(String queryModelName, String parentPath, String name) Deprecated. Save the specified stateful QueryModel.
QueryModel	persist(String queryModelName, String parentPath, String name, boolean saveSession) Deprecated. Save the specified stateful QueryModel.
void	queryModelChanged(QueryModel qm) Deprecated. Observer on Seam event to perform some necessary invalidations
void	reset(String queryModelName) Deprecated. Reset the specified QueryModel.

Methods inherited from interface org.nuxeo.ecm.platform.ui.web.api.ResultsProviderFarm

getResultsProvider, getResultsProvider

Method Detail

isInitialized

boolean isInitialized()

Deprecated.

get

QueryModel get(String queryModelName)
               throws ClientException

Deprecated.

Obtain a scoped instance of QueryModel.

Throws:

ClientException

persist

QueryModel persist(String queryModelName,
                 String parentPath,
                 String name)
                   throws ClientException

Deprecated.

Save the specified stateful QueryModel.

This is equivalent to the other signature, with saveSession set to True

Parameters:

queryModelName -

parentPath - The path of parent folder to save into

name - The local name to use.

Returns:

The saved query model.

Throws:

ClientException - forwarding from the Core, stateless QueryModel, if QueryModel has already been persisted

Since:

5.2

persist

QueryModel persist(String queryModelName,
                 String parentPath,
                 String name,
                 boolean saveSession)
                   throws ClientException

Deprecated.

Save the specified stateful QueryModel.

The DocumentModel instance that backs the QueryModel is saved in the CoreSession available in Seam's context. Necessary updates are performed. The returned QueryModel instance is identical to the one obtained by a subsequent call to get.

Further document operations, e.g., modifications, for this QueryModel can be done on the DocumentModel instance directly, but CoreSession methods returning a new DocumentModel instance must be followed by a call to load and dependent objects (page providers, etc.) must be updated as well.

It is not possible to call again this method on the same QueryModel, to avoid consistency problems at the DocumentModel level. Therefore If one wants to save a QueryModel, then change and eventually save it to a different target in Nuxeo Core, one must call the reset method before performing the changes.

Parameters:

queryModelName -

parentPath - The path of parent folder to save into

name - The local name to use.

saveSession - if true, the Core Session is saved

Returns:

The saved query model.

Throws:

ClientException - forwarding from the Core, stateless QueryModel, if QueryModel has already been persisted

Since:

5.2

load

QueryModel load(String queryModelName,
              DocumentRef ref)
                throws ClientException

Deprecated.

Load a stateful QueryModel from the specified DocumentRef.

The queryModelChanged event is thrown, meaning in particular that ResultsProviderCache invalidation is performed.

Parameters:

queryModelName -

ref -

Returns:

The loaded QueryModel instance.

Throws:

ClientException - if qm is not stateful, document could not be retrieved.

Since:

5.2

isPersisted

boolean isPersisted(String queryModelName)
                    throws ClientException

Deprecated.

Tell if the DocumentModel behind the specified QueryModel has been persisted in Nuxeo Core.

Parameters:

queryModelName - The query model name

Throws:

ClientException

Since:

5.2

reset

void reset(String queryModelName)
           throws ClientException

Deprecated.

Reset the specified QueryModel.

Start over with a fresh, transient DocumentModel instance.

Parameters:

queryModelName -

Throws:

ClientException

queryModelChanged

void queryModelChanged(QueryModel qm)

Deprecated.

Observer on Seam event to perform some necessary invalidations

Parameters:

qm - the query model that's been changed