org.nuxeo.ecm.core.query
Class QueryFilter

java.lang.Object
  org.nuxeo.ecm.core.query.QueryFilter

All Implemented Interfaces:

java.io.Serializable

public class QueryFilter
extends java.lang.Object
implements java.io.Serializable

Filtering parameters that can be passed when executing a FilterableQuery.

This includes filtering on the BROWSE permission for the given principal, filtering on facets, and applying query transformers.

You can also include a limit and offset, to get a subset of the total.

Author:

Florent Guillaume

See Also:

Serialized Form

Field Summary

static QueryFilter

EMPTY

Constructor Summary

QueryFilter(java.security.Principal principal, java.lang.String[] principals, java.lang.String[] permissions, FacetFilter facetFilter, java.util.Collection<SQLQuery.Transformer> queryTransformers, long limit, long offset)
Constructs a query filter.

Method Summary

FacetFilter	getFacetFilter()
long	getLimit()
long	getOffset()
java.lang.String[]	getPermissions()
java.security.Principal	getPrincipal()
java.lang.String[]	getPrincipals()
java.util.Collection<SQLQuery.Transformer>	getQueryTransformers()
static QueryFilter	withoutLimitOffset(QueryFilter other)

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY

public static final QueryFilter EMPTY

Constructor Detail

QueryFilter

public QueryFilter(java.security.Principal principal,
                   java.lang.String[] principals,
                   java.lang.String[] permissions,
                   FacetFilter facetFilter,
                   java.util.Collection<SQLQuery.Transformer> queryTransformers,
                   long limit,
                   long offset)

Constructs a query filter.

Note that the principal MUST be Serializable.

Method Detail

withoutLimitOffset

public static QueryFilter withoutLimitOffset(QueryFilter other)

getPrincipal

public java.security.Principal getPrincipal()

getPrincipals

public java.lang.String[] getPrincipals()

getPermissions

public java.lang.String[] getPermissions()

getFacetFilter

public FacetFilter getFacetFilter()

getQueryTransformers

public java.util.Collection<SQLQuery.Transformer> getQueryTransformers()

getLimit

public long getLimit()

getOffset

public long getOffset()