ColdBox Platform Version 3.7.0

coldbox.system.orm.hibernate
Class CriteriaBuilder

WEB-INF.cftags.component
        extended by coldbox.system.orm.hibernate.BaseBuilder
            extended by coldbox.system.orm.hibernate.CriteriaBuilder

public class CriteriaBuilder
extends BaseBuilder

Constructor Summary
init(string entityName, [boolean useQueryCaching='false'], [string queryCacheRegion=''])
 
Method Summary
 array GETCRITERIAS()
 string GETQUERYCACHEREGION()
 boolean GETUSEQUERYCACHING()
 void SETCRITERIAS(array criterias)
 void SETQUERYCACHEREGION(string queryCacheRegion)
 void SETUSEQUERYCACHING(boolean useQueryCaching)
 any cache(boolean cache='true', [string cacheRegion])
 any cacheRegion(string cacheRegion)
 numeric count([any propertyName=''])
          Get the record count using hibernate projections for the given criterias
 any createSubcriteria(string entityName, [string alias=''])
 any fetchSize(numeric fetchSize)
 any firstResult(numeric firstResult)
 any get()
private any getORMUtil()
          Get ORM Util
 any list([numeric offset='0'], [numeric max='0'], [numeric timeout='0'], [string sortOrder=''], [boolean ignoreCase='false'], [boolean asQuery='false'])
          Execute the criteria queries you have defined and return the results, you can pass optional parameters or define them via our methods
 any maxResults(numeric maxResults)
 any onMissingMethod(string missingMethodName, struct missingMethodArguments)
 any readOnly([boolean readOnly='true'])
 any timeout(numeric timeout)
 
Methods inherited from class coldbox.system.orm.hibernate.BaseBuilder
GETENTITYNAME, GETNATIVECRITERIA, SETENTITYNAME, add, addProjection, convertIDValueToJavaType, convertValueToJavaType, createAlias, createCriteria, createRestriction, normalizeOrder, order, prepareSQLProjection, resultTransformer, setNativeCriteria, setProjection, withProjections
 
Methods inherited from class WEB-INF.cftags.component
 

Constructor Detail

init

public init(string entityName, [boolean useQueryCaching='false'], [string queryCacheRegion=''])

Parameters:
entityName
useQueryCaching
queryCacheRegion
Method Detail

GETCRITERIAS

public array GETCRITERIAS()


GETQUERYCACHEREGION

public string GETQUERYCACHEREGION()


GETUSEQUERYCACHING

public boolean GETUSEQUERYCACHING()


SETCRITERIAS

public void SETCRITERIAS(array criterias)

Parameters:
criterias

SETQUERYCACHEREGION

public void SETQUERYCACHEREGION(string queryCacheRegion)

Parameters:
queryCacheRegion

SETUSEQUERYCACHING

public void SETUSEQUERYCACHING(boolean useQueryCaching)

Parameters:
useQueryCaching

cache

public any cache(boolean cache='true', [string cacheRegion])

Parameters:
cache
cacheRegion

cacheRegion

public any cacheRegion(string cacheRegion)

Parameters:
cacheRegion

count

public numeric count([any propertyName=''])
Get the record count using hibernate projections for the given criterias

Parameters:
propertyName - The name of the property to do the count on or do it for all row results instead

createSubcriteria

public any createSubcriteria(string entityName, [string alias=''])

Parameters:
entityName
alias

fetchSize

public any fetchSize(numeric fetchSize)

Parameters:
fetchSize

firstResult

public any firstResult(numeric firstResult)

Parameters:
firstResult

get

public any get()


getORMUtil

private any getORMUtil()
Get ORM Util


list

public any list([numeric offset='0'], [numeric max='0'], [numeric timeout='0'], [string sortOrder=''], [boolean ignoreCase='false'], [boolean asQuery='false'])
Execute the criteria queries you have defined and return the results, you can pass optional parameters or define them via our methods

Parameters:
offset
max
timeout
sortOrder
ignoreCase
asQuery

maxResults

public any maxResults(numeric maxResults)

Parameters:
maxResults

onMissingMethod

public any onMissingMethod(string missingMethodName, struct missingMethodArguments)

Parameters:
missingMethodName
missingMethodArguments

readOnly

public any readOnly([boolean readOnly='true'])

Parameters:
readOnly

timeout

public any timeout(numeric timeout)

Parameters:
timeout

ColdBox Platform Version 3.7.0