BuildableCriteria (GORM for Hibernate 5

org.hibernate.criterion.CriteriaSpecification

All Superinterfaces:

org.hibernate.criterion.CriteriaSpecification

Authors:
Jeff Brown
Since:
3.1.2

Inherited fields
Fields inherited from class	Fields
`interface org.hibernate.Criteria`	`ROOT_ALIAS, ALIAS_TO_ENTITY_MAP, ROOT_ENTITY, DISTINCT_ROOT_ENTITY, PROJECTION, INNER_JOIN, FULL_JOIN, LEFT_JOIN`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`BuildableCriteria`	`cache(boolean cache)` Whether to cache the query
	`java.lang.Object`	`get(groovy.lang.Closure closure)` Defines and executes a get query ( a single result) in a single call.
	`java.lang.Class`	`getTargetClass()` @return The class the criteria applies to
	`BuildableCriteria`	`join(java.lang.String property)` Whether to join on an association
	`BuildableCriteria`	`join(java.lang.String property, javax.persistence.criteria.JoinType joinType)` Whether to join on an association
	`java.lang.Object`	`list(groovy.lang.Closure closure)` Defines and executes a list query in a single call.
	`java.lang.Object`	`list(java.util.Map params, groovy.lang.Closure closure)` Defines and executes a list query in a single call.
	`java.lang.Object`	`listDistinct(groovy.lang.Closure closure)` Defines and executes a list distinct query in a single call.
	`BuildableCriteria`	`readOnly(boolean readOnly)` Whether to cache the query should be readOnly
	`java.lang.Object`	`scroll(groovy.lang.Closure closure)` Defines and executes a scroll query in a single call.
	`BuildableCriteria`	`select(java.lang.String property)` Whether to select on an association

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`interface org.hibernate.Criteria`	org.hibernate.Criteria#setComment(java.lang.String), org.hibernate.Criteria#addOrder(org.hibernate.criterion.Order), org.hibernate.Criteria#setFetchSize(int), org.hibernate.Criteria#getAlias(), org.hibernate.Criteria#setFetchMode(java.lang.String, org.hibernate.FetchMode), org.hibernate.Criteria#setLockMode(java.lang.String, org.hibernate.LockMode), org.hibernate.Criteria#setLockMode(org.hibernate.LockMode), org.hibernate.Criteria#createAlias(java.lang.String, java.lang.String, int), org.hibernate.Criteria#createAlias(java.lang.String, java.lang.String, org.hibernate.sql.JoinType, org.hibernate.criterion.Criterion), org.hibernate.Criteria#createAlias(java.lang.String, java.lang.String, int, org.hibernate.criterion.Criterion), org.hibernate.Criteria#createAlias(java.lang.String, java.lang.String, org.hibernate.sql.JoinType), org.hibernate.Criteria#createAlias(java.lang.String, java.lang.String), org.hibernate.Criteria#setCacheable(boolean), org.hibernate.Criteria#setTimeout(int), org.hibernate.Criteria#createCriteria(java.lang.String, java.lang.String, int), org.hibernate.Criteria#createCriteria(java.lang.String, java.lang.String, org.hibernate.sql.JoinType, org.hibernate.criterion.Criterion), org.hibernate.Criteria#createCriteria(java.lang.String, java.lang.String, int, org.hibernate.criterion.Criterion), org.hibernate.Criteria#createCriteria(java.lang.String), org.hibernate.Criteria#createCriteria(java.lang.String, org.hibernate.sql.JoinType), org.hibernate.Criteria#createCriteria(java.lang.String, int), org.hibernate.Criteria#createCriteria(java.lang.String, java.lang.String), org.hibernate.Criteria#createCriteria(java.lang.String, java.lang.String, org.hibernate.sql.JoinType), org.hibernate.Criteria#setResultTransformer(org.hibernate.transform.ResultTransformer), org.hibernate.Criteria#setMaxResults(int), org.hibernate.Criteria#setFirstResult(int), org.hibernate.Criteria#isReadOnlyInitialized(), org.hibernate.Criteria#setCacheRegion(java.lang.String), org.hibernate.Criteria#addQueryHint(java.lang.String), org.hibernate.Criteria#setCacheMode(org.hibernate.CacheMode), org.hibernate.Criteria#scroll(org.hibernate.ScrollMode), org.hibernate.Criteria#scroll(), org.hibernate.Criteria#uniqueResult(), org.hibernate.Criteria#setProjection(org.hibernate.criterion.Projection), org.hibernate.Criteria#setFlushMode(org.hibernate.FlushMode), org.hibernate.Criteria#add(org.hibernate.criterion.Criterion), org.hibernate.Criteria#setReadOnly(boolean), org.hibernate.Criteria#list(), org.hibernate.Criteria#isReadOnly()
`class java.lang.Object`	`java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Method Detail
  - public BuildableCriteria cache(boolean cache)
    
    Whether to cache the query
    Parameters:
    cache - True if the query should be cached
    Returns:
    This criteria
  - public java.lang.Object get(@DelegatesTo(Criteria.class) groovy.lang.Closure closure)
    
    Defines and executes a get query ( a single result) in a single call. Example: Foo.createCriteria().get { }
    Parameters:
    closure - The closure to execute
    Returns:
    A single result
  - public java.lang.Class getTargetClass()
    
    Returns:
    The class the criteria applies to
  - public BuildableCriteria join(java.lang.String property)
    
    Whether to join on an association
    Parameters:
    property - The property to join on
    Returns:
    This criteria
  - public BuildableCriteria join(java.lang.String property, javax.persistence.criteria.JoinType joinType)
    
    Whether to join on an association
    Parameters:
    property - The property to join on
    joinType - The type of join
    Returns:
    This criteria
  - public java.lang.Object list(@DelegatesTo(Criteria.class) groovy.lang.Closure closure)
    
    Defines and executes a list query in a single call. Example: Foo.createCriteria().list { }
    Parameters:
    closure - The closure to execute
    Returns:
    The result
  - public java.lang.Object list(java.util.Map params, @DelegatesTo(Criteria.class) groovy.lang.Closure closure)
    
    Defines and executes a list query in a single call. Example: Foo.createCriteria().list { }
    Parameters:
    params - pagination parameters (max, offset, etc...)
    closure - The closure to execute
    Returns:
    The result
  - public java.lang.Object listDistinct(@DelegatesTo(Criteria.class) groovy.lang.Closure closure)
    
    Defines and executes a list distinct query in a single call. Example: Foo.createCriteria().listDistinct { }
    Parameters:
    closure - The closure to execute
    Returns:
    The result
  - public BuildableCriteria readOnly(boolean readOnly)
    
    Whether to cache the query should be readOnly
    Parameters:
    readOnly - True if the results should be read-only
    Returns:
    This criteria
  - public java.lang.Object scroll(@DelegatesTo(Criteria.class) groovy.lang.Closure closure)
    
    Defines and executes a scroll query in a single call. Example: Foo.createCriteria().scroll { }
    Parameters:
    closure - The closure to execute
    Returns:
    A scrollable result set
  - public BuildableCriteria select(java.lang.String property)
    
    Whether to select on an association
    Parameters:
    property - The property to join on
    Returns:
    This criteria

Summary:
Method

| Detail:
Method

[Java] Interface BuildableCriteria

Methods Summary

Inherited Methods Summary

Method Detail

public BuildableCriteria cache(boolean cache)

public java.lang.Object get(@DelegatesTo(Criteria.class) groovy.lang.Closure closure)

public java.lang.Class getTargetClass()

public BuildableCriteria join(java.lang.String property)

public BuildableCriteria join(java.lang.String property, javax.persistence.criteria.JoinType joinType)

public java.lang.Object list(@DelegatesTo(Criteria.class) groovy.lang.Closure closure)

public java.lang.Object list(java.util.Map params, @DelegatesTo(Criteria.class) groovy.lang.Closure closure)

public java.lang.Object listDistinct(@DelegatesTo(Criteria.class) groovy.lang.Closure closure)

public BuildableCriteria readOnly(boolean readOnly)

public java.lang.Object scroll(@DelegatesTo(Criteria.class) groovy.lang.Closure closure)

public BuildableCriteria select(java.lang.String property)