org.proteios.core.query
Interface EntityQuery

All Superinterfaces:

HqlQuery, Query

All Known Implementing Classes:

DataQuery, ItemQuery

public interface EntityQuery
extends HqlQuery

This a HQL query that return enitities, ie. items. The items may be returned in the form of data classes (DataQuery) or in the form of item classes (ItemQuery).

Version:

2.0

Author:

Nicklas

See Also:

ItemQuery, DataQuery

Last modified

$Date: 2009-04-09 08:48:11 +0200 (Thu, 09 Apr 2009) $

Method Summary

void	exclude(Include... excludes) Specify options for which items to exclude from the result.
Item	getItemType() The type of items the query returns.
void	include(Include... includes) Specify options for which items to include in the result.
boolean	isIncluded(Include... includes) Check which options are set for the items to include in the result

Methods inherited from interface org.proteios.core.query.HqlQuery

isCachingResult, setCacheResult

Methods inherited from interface org.proteios.core.query.Query

count, getFirstResult, getMaxResults, getQueryType, getRootAlias, group, groupPermanent, hasParameterValue, having, havingPermanent, isDistinct, isReadonly, isReturningTotalCount, join, joinPermanent, order, orderPermanent, reset, restrict, restrictPermanent, select, selectPermanent, setDistinct, setFirstResult, setMaxResults, setParameter, setPermanentParameter, setReturnTotalCount

Method Detail

getItemType

Item getItemType()

The type of items the query returns.

include

void include(Include... includes)

Specify options for which items to include in the result.

Parameters:

includes - An array of items that should be included

Throws:

UnsupportedOperationException - If this operation isn't supported by the implementation

See Also:

exclude(Include[])

Developer info

These options are implemented as Hibernate filters. See org.proteios.core.QueryRuntimeFilterFactory

exclude

void exclude(Include... excludes)

Specify options for which items to exclude from the result.

Parameters:

excludes - An array of options that should be excluded

Throws:

UnsupportedOperationException - If this operation isn't supported by the implementation

See Also:

include(Include[])

Developer info

These options are implemented as Hibernate filters. See org.proteios.core.QueryRuntimeFilterFactory

isIncluded

boolean isIncluded(Include... includes)

Check which options are set for the items to include in the result

Parameters:

includes - The options to check

Returns:

TRUE If all specified options are included, FALSE otherwise