public class ItemQuery<I extends BasicItem> extends AbstractEntityQuery
Query
interface that returns item
objects. This type of query is used for all items except those that
are batchable, for example reporters and raw data. The result of a
query can be returned as a list or an iterator.Modifier and Type | Field and Description |
---|---|
private Class<? extends BasicData> |
dataClass
The data layer class of the item objects that are returned.
|
private Class<I> |
itemClass
The class of the item objects that are returned.
|
Constructor and Description |
---|
ItemQuery(Class<I> itemClass)
Create a new query for the specified item, using the default optional
runtime filter.
|
ItemQuery(Class<I> itemClass,
QueryRuntimeFilter optionalFilter)
Create a new query for the specified item, using a non-default optional
runtime filter.
|
Modifier and Type | Method and Description |
---|---|
ItemResultIterator<I> |
iterate(DbControl dc)
Execute the query and return the results as an iterator.
|
ItemResultList<I> |
list(DbControl dc)
Execute the query and return the results as a list.
|
count, disableFilters, enableFilters, exclude, exclude, getItemPermission, getItemType, getQueryType, getRootType, group, groupPermanent, having, havingPermanent, include, include, isIncluded, isIncluded, select, selectPermanent, setAutoJoinType, setIncludes, setItemPermission
getCountHqlQuery, getMainHqlQuery, getRootAlias, isCachingResult, isReadonly, isStateless, postProcessQuery, reset, setCacheResult, setEntityParameter, setPermanentEntityParameter
addAutoJoiner, getCountQuery, getFirstResult, getMainQuery, getMaxResults, getParameterNames, getParameters, getParameterType, getParameterValue, getPermanentSelects, getQueryParameter, getQuerySection, getSelects, hasParameterValue, isCounting, isDistinct, isFailSafe, isReturningTotalCount, join, joinPermanent, order, orderPermanent, resetTemporary, restrict, restrictPermanent, setCounting, setDistinct, setFailSafe, setFirstResult, setMaxResults, setParameter, setPermanentParameter, setReturnTotalCount, temporaryJoin, temporarySelect, toQl, toString
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
isCachingResult, setCacheResult, setEntityParameter, setPermanentEntityParameter
addAutoJoiner, getFirstResult, getMaxResults, getParameterNames, getQueryParameter, getQuerySection, getRootAlias, hasParameterValue, isCounting, isDistinct, isFailSafe, isReadonly, isReturningTotalCount, join, joinPermanent, order, orderPermanent, reset, restrict, restrictPermanent, setDistinct, setFailSafe, setFirstResult, setMaxResults, setParameter, setPermanentParameter, setReturnTotalCount, toQl
private final Class<I extends BasicItem> itemClass
ItemQuery(Class<I> itemClass)
itemClass
- The class of the item objects that are returnedItemQuery(Class<I> itemClass, QueryRuntimeFilter optionalFilter)
itemClass
- The class of the item objects that are returnedoptionalFilter
- A runtime filter replacing the default optional filter
or null to not use any optional filterpublic ItemResultList<I> list(DbControl dc) throws BaseException
dc
- The DbControl
used to access the database
and check permissionsBaseException
- If there is an errorpublic ItemResultIterator<I> iterate(DbControl dc) throws BaseException
dc
- The DbControl
used to access the database
and check permissionsBaseException
- If there is an error