oracle.webcenter.portal.persistence.query

Interface Query<T extends PortalEntity>

Type Parameters:

T - the return type of the query

All Superinterfaces:

AbstractQuery<T>

public interface Query<T extends PortalEntity>
extends AbstractQuery<T>

Interface used to build and execute a dynamic query

Method Summary

Modifier and Type	Method and Description
Query<T>	from(java.lang.Class<? extends T>... types) Sets the list of types of objects to find.
java.util.List<T>	getResultList() Gets the results of the query
Query<T>	orderBy(Order... o) Specify the ordering operations that are used to order the query results.
Query<T>	setPaginationRule(PaginationRule paginationRule) Sets the pagination rule.
Query<T>	setQueryUnindexed(boolean queryUnindexed) Sets the mode for querying unindexed properties.
Query<T>	where(Expression restriction) Modify the query to restrict the query result according to the specified expression.

Methods inherited from interface oracle.webcenter.portal.persistence.query.AbstractQuery

getReturnType, toExpression

Method Detail

from

Query<T> from(java.lang.Class<? extends T>... types)

Sets the list of types of objects to find. Only entities in the portal that have a specific type matching one of the types in the supplied list will be queried i.e. sub-types of the specified types will not be incldued.

Parameters:

types - a list of types of objects to find

Returns:

the modified query

where

Query<T> where(Expression restriction)

Modify the query to restrict the query result according to the specified expression. Replaces the previously added restriction(s), if any.

Parameters:

restriction - the expression used to restrict the query result

Returns:

the modified query

orderBy

Query<T> orderBy(Order... o)

Specify the ordering operations that are used to order the query results. Replaces the previous ordering operations, if any. If no ordering operations are specified, the previous ordering, if any, is simply removed and results will be returned in no particular order. The left-to-right sequence of the ordering operations determines the precedence, whereby the leftmost has highest precedence.

Parameters:

o - zero or more ordering operations

Returns:

the modified query

setPaginationRule

Query<T> setPaginationRule(PaginationRule paginationRule)

Sets the pagination rule.

Parameters:

paginationRule - the pagination rule

Returns:

the modifed query

setQueryUnindexed

Query<T> setQueryUnindexed(boolean queryUnindexed)

Sets the mode for querying unindexed properties.

By default the query will throw an exception if an attempt to query an unindexed property is made; this behaviour can be changed by enabling the mode for quering unindexed properties.

Parameters:

queryUnindexed - true if it should allow querying of unindexed properties, otherwise false

Returns:

the modified query

getResultList

java.util.List<T> getResultList()
                         throws oracle.webcenter.portal.PortalOptimisticLockException

Gets the results of the query

Returns:

the results

Throws:

oracle.webcenter.portal.PortalOptimisticLockException - another transaction has updated objects in the current active transaction.