org.hippoecm.hst.content.beans.query
Interface HstQueryManager

All Known Implementing Classes:

HstQueryManagerImpl

public interface HstQueryManager

Method Summary

HstQuery	createQuery(HippoBean scope) Creates a empty query, with scope
HstQuery	createQuery(HippoBean scope, Class<? extends HippoBean>... filterBean) Creates a query, with a scope and with a Filter that filters to only return HippoBeans of the types that are added as variable arguments.
HstQuery	createQuery(HippoBean scope, Class<? extends HippoBean> filterBean, boolean includeSubTypes) Creates a query, with scope HippoBean and Filter for types of filterBean.
HstQuery	createQuery(HippoBean scope, String... primaryNodeTypes) Creates a query, with a scope and with a Filter that filters to only return HippoBeans of the types that are added as variable arguments.
HstQuery	createQuery(javax.jcr.Node scope) Creates a empty query, with scope
HstQuery	createQuery(javax.jcr.Node scope, Class<? extends HippoBean>... filterBeans) Creates a query, with the scope HippoBean and with a Filter that filters to only return HippoBeans of the types that are added as variable arguments.
HstQuery	createQuery(javax.jcr.Node scope, Class<? extends HippoBean> filterBean, boolean includeSubTypes) Creates a query, with scope and Filter for types of filterBean.
HstQuery	createQuery(javax.jcr.Node scope, String... primaryNodeTypes) Creates a query, with the scope HippoBean and with a Filter that filters to only return HippoBeans of the types that are added as variable arguments.
HstQuery	createQuery(javax.jcr.Node scope, String nodeType, boolean includeSubTypes) Creates a query, with scope and Filter for node types.

Method Detail

createQuery

HstQuery createQuery(javax.jcr.Node scope)
                     throws QueryException

Creates a empty query, with scope

Parameters:

scope -

Returns:

a new HstQuery with scope scope

Throws:

QueryException

createQuery

HstQuery createQuery(javax.jcr.Node scope,
                     Class<? extends HippoBean> filterBean,
                     boolean includeSubTypes)
                     throws QueryException

Creates a query, with scope and Filter for types of filterBean. If includeSubTypes is true, the result may also contain HippoBean's whose primarytype is a subtype of the filterBean type.

Parameters:

scope -

filterBean -

includeSubTypes -

Returns:

a new HstQuery with scope & filter

Throws:

QueryException

createQuery

HstQuery createQuery(javax.jcr.Node scope,
                     String nodeType,
                     boolean includeSubTypes)
                     throws QueryException

Creates a query, with scope and Filter for node types. If includeSubTypes is true, the result may also contain node types whose primary type is a subtype of the filter node type.

Parameters:

scope -

nodeType -

includeSubTypes -

Returns:

a new HstQuery with scope & filter

Throws:

QueryException

createQuery

HstQuery createQuery(HippoBean scope)
                     throws QueryException

Creates a empty query, with scope

Parameters:

scope -

Returns:

a new HstQuery with scope scope

Throws:

QueryException

createQuery

HstQuery createQuery(HippoBean scope,
                     Class<? extends HippoBean> filterBean,
                     boolean includeSubTypes)
                     throws QueryException

Creates a query, with scope HippoBean and Filter for types of filterBean. If includeSubTypes is true, the result may also contain HippoBean's whose primarytype is a subtype of the filterBean type.

Parameters:

scope -

filterBean -

includeSubTypes -

Returns:

a new HstQuery with scope & filter

Throws:

QueryException

createQuery

HstQuery createQuery(javax.jcr.Node scope,
                     Class<? extends HippoBean>... filterBeans)
                     throws QueryException

Creates a query, with the scope HippoBean and with a Filter that filters to only return HippoBeans of the types that are added as variable arguments. It is not possible to retrieve subtypes of the applied filterBeans. If needed, use #createQuery(HstRequestContext, HippoBean, Class, boolean) instead.

Parameters:

scope -

filterBeans -

Returns:

a new HstQuery with scope & filter on jcr primary nodetype of the filterBean

Throws:

QueryException

createQuery

HstQuery createQuery(javax.jcr.Node scope,
                     String... primaryNodeTypes)
                     throws QueryException

Creates a query, with the scope HippoBean and with a Filter that filters to only return HippoBeans of the types that are added as variable arguments. It is not possible to retrieve subtypes of the applied primary node types. If needed, use #createQuery(HstRequestContext, HippoBean, Class, boolean) instead.

Parameters:

scope -

primaryNodeTypes -

Returns:

a new HstQuery with scope & filter on jcr primary nodetype of the filterBean

Throws:

QueryException

createQuery

HstQuery createQuery(HippoBean scope,
                     Class<? extends HippoBean>... filterBean)
                     throws QueryException

Creates a query, with a scope and with a Filter that filters to only return HippoBeans of the types that are added as variable arguments. It is not possible to retrieve subtypes of the applied filterBeans with this method. If needed, use #createQuery(HstRequestContext, Node, Class, boolean) instead.

Parameters:

scope -

filterBean -

Returns:

a new HstQuery with scope and filter on jcr primary nodetype of the filterBean

Throws:

QueryException

createQuery

HstQuery createQuery(HippoBean scope,
                     String... primaryNodeTypes)
                     throws QueryException

Creates a query, with a scope and with a Filter that filters to only return HippoBeans of the types that are added as variable arguments. It is not possible to retrieve subtypes of the applied primary node types with this method. If needed, use #createQuery(HstRequestContext, Node, Class, boolean) instead.

Parameters:

scope -

primaryNodeTypes -

Returns:

a new HstQuery with scope and filter on jcr primary nodetype of the filterBean

Throws:

QueryException