public interface EntityQuery extends HqlQuery
DataQuery
) or
in the form of item classes (ItemQuery
).Modifier and Type | Method and Description |
---|---|
void |
exclude(java.util.Collection<Include> excludes) |
void |
exclude(Include... excludes)
Specify options for which items to exclude from the result.
|
Permission |
getItemPermission()
The logged in user's permission on the items returned by this query.
|
Item |
getItemType()
The type of items the query returns.
|
Item |
getRootType()
The type of items that is the root of the query.
|
java.util.List<java.lang.Integer> |
idList(DbControl dc)
Execute the query and return the ID values of all items matching
the query.
|
void |
include(java.util.Collection<Include> includes) |
void |
include(Include... includes)
Specify options for which items to include in the result.
|
boolean |
isIncluded(java.util.Collection<Include> includes) |
boolean |
isIncluded(Include... includes)
Check which options are set for the items to include in the result
|
void |
setIncludes(java.util.Collection<Include> includes)
Clears the lists of includes and adds a new collection.
|
void |
setItemPermission(Permission permission)
Only return items which the logged in user has the specified
permission for.
|
isCachingResult, setCacheResult, setEntityParameter, setPermanentEntityParameter
addAutoJoiner, count, getFirstResult, getMaxResults, getParameterNames, getQueryParameter, getQuerySection, getQueryType, getRootAlias, group, groupPermanent, hasParameterValue, having, havingPermanent, isCounting, isDistinct, isFailSafe, isReadonly, isReturningTotalCount, join, joinPermanent, order, orderPermanent, reset, restrict, restrictPermanent, select, selectPermanent, setDistinct, setFailSafe, setFirstResult, setMaxResults, setParameter, setPermanentParameter, setReturnTotalCount, toQl
Item getItemType()
Item getRootType()
getItemType()
, but not
always.void include(Include... includes)
includes
- An array of items that should be includedjava.lang.UnsupportedOperationException
- If this operation isn't supported by
the implementationexclude(Include[])
void include(java.util.Collection<Include> includes)
include(Include[])
void setIncludes(java.util.Collection<Include> includes)
includes
- The new includes to be hold in the list.include(Include...)
void exclude(Include... excludes)
excludes
- An array of options that should be excludedjava.lang.UnsupportedOperationException
- If this operation isn't supported by
the implementationinclude(Include[])
void exclude(java.util.Collection<Include> excludes)
exclude(Include[])
boolean isIncluded(Include... includes)
includes
- The options to checkboolean isIncluded(java.util.Collection<Include> includes)
isIncluded(Include[])
void setItemPermission(Permission permission)
permission
- The required permissionPermission getItemPermission()
java.util.List<java.lang.Integer> idList(DbControl dc)
dc
- The DbControl
used to access the database
and check permissionsBaseException
- If there is an error