Package org.hippoecm.hst.content.beans.query

Interface HstQueryManager

public interface HstQueryManager

Method Summary

Modifier and Type	Method	Description
HstQuery	createQuery(Node scope)	Creates a empty query, with scope
HstQuery	createQuery(Node scope, boolean includeSubTypes, Class<? extends HippoBean>... filterBeans)
HstQuery	createQuery(Node scope, boolean includeSubTypes, String... primaryNodeTypes)
HstQuery	createQuery(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(Node scope, Class<? extends HippoBean> filterBean, boolean includeSubTypes)	Creates a query, with scope and Filter for types of filterBean.
HstQuery	createQuery(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(Node scope, String nodeType, boolean includeSubTypes)	Creates a query, with scope and Filter for node types.
HstQuery	createQuery(HippoBean scope)	Creates a empty query, with scope
HstQuery	createQuery(HippoBean scope, boolean includeSubTypes, Class<? extends HippoBean>... filterBean)
HstQuery	createQuery(HippoBean scope, boolean includeSubTypes, String... primaryNodeTypes)
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.
DateTools.Resolution	getDefaultResolution()
ObjectConverter	getObjectConverter()
Session	getSession()

Method Detail

getSession

Session getSession()

Returns:

the Session which was used to create this HstQueryManager with

getDefaultResolution

DateTools.Resolution getDefaultResolution()

Returns:

the default {@link DateTools.Resolution} for this HstQueryManager instance

getObjectConverter

ObjectConverter getObjectConverter()

Returns:

the ObjectConverter that was used to create this HstQueryManager instance

createQuery

HstQuery createQuery(Node scope)
              throws QueryException

Creates a empty query, with scope

Parameters:

scope -

Returns:

a new HstQuery with scope scope

Throws:

QueryException

createQuery

HstQuery createQuery(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(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(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.

Parameters:

scope -

filterBeans -

Returns:

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

Throws:

QueryException

createQuery

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

Throws:

QueryException

See Also:

createQuery(Node scope, Class? extends HippoBean... filterBeans) only now also subtypes of filterBeans are included if includeSubTypes = true

createQuery

HstQuery createQuery(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.

Parameters:

scope -

primaryNodeTypes -

Returns:

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

Throws:

QueryException

createQuery

HstQuery createQuery(Node scope,
                     boolean includeSubTypes,
                     String... primaryNodeTypes)
              throws QueryException

Throws:

QueryException

See Also:

createQuery(Node scope, String ... primaryNodeTypes) only now also subtypes of filterBeans are included if includeSubTypes = true

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.

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,
                     boolean includeSubTypes,
                     Class<? extends HippoBean>... filterBean)
              throws QueryException

Throws:

QueryException

See Also:

createQuery(HippoBean scope, Class? extends HippoBean... filterBean) only now also subtypes of filterBeans are included if includeSubTypes = true

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.

Parameters:

scope -

primaryNodeTypes -

Returns:

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

Throws:

QueryException

createQuery

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

Throws:

QueryException

See Also:

createQuery(HippoBean scope, String ... primaryNodeTypes) only now also subtypes of filterBeans are included if includeSubTypes = true