|
2.17.2: 2011-06-17 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface EntityQuery
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
).
Method Summary | |
---|---|
void |
exclude(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. |
void |
include(Collection<Include> includes)
|
void |
include(Include... includes)
Specify options for which items to include in the result. |
boolean |
isIncluded(Collection<Include> includes)
|
boolean |
isIncluded(Include... includes)
Check which options are set for the items to include in the result |
void |
setIncludes(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. |
Methods inherited from interface net.sf.basedb.core.query.HqlQuery |
---|
isCachingResult, setCacheResult, setEntityParameter, setPermanentEntityParameter |
Methods inherited from interface net.sf.basedb.core.query.Query |
---|
addAutoJoiner, count, getFirstResult, getMaxResults, getParameterNames, getQueryParameter, getQuerySection, getQueryType, getRootAlias, group, groupPermanent, hasParameterValue, having, havingPermanent, isCounting, isDistinct, isReadonly, isReturningTotalCount, join, joinPermanent, order, orderPermanent, reset, restrict, restrictPermanent, select, selectPermanent, setDistinct, setFirstResult, setMaxResults, setParameter, setPermanentParameter, setReturnTotalCount, toQl |
Method Detail |
---|
Item getItemType()
Item getRootType()
getItemType()
, but not
always.
void include(Include... includes)
includes
- An array of items that should be included
UnsupportedOperationException
- If this operation isn't supported by
the implementationexclude(Include[])
QueryRuntimeFilterFactory
void include(Collection<Include> includes)
include(Include[])
void setIncludes(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 excluded
UnsupportedOperationException
- If this operation isn't supported by
the implementationinclude(Include[])
QueryRuntimeFilterFactory
void exclude(Collection<Include> excludes)
exclude(Include[])
boolean isIncluded(Include... includes)
includes
- The options to check
boolean isIncluded(Collection<Include> includes)
isIncluded(Include[])
void setItemPermission(Permission permission)
permission
- The required permissionPermission getItemPermission()
|
2.17.2: 2011-06-17 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |