Callable

Class

ColdBox Platform Version 2.6.4

FRAMES

coldbox.system.orm.hibernate
Class VirtualEntityService

WEB-INF.cftags.component
        coldbox.system.orm.hibernate.BaseORMService
            coldbox.system.orm.hibernate.VirtualEntityService

public class VirtualEntityService
extends BaseORMService
extends BaseORMService

******************************************************************************* Copyright Since 2005 ColdBox Framework by Luis Majano and Ortus Solutions, Corp www.coldbox.org | www.luismajano.com | www.ortussolutions.com ******************************************************************************* Author : Curt Gratz & Luis Majano Description : This is a Virtual Entity Service that extends the Coldbox BaseORMService to provide easy access to creating virtual services that extend the BaseORMService For example, if you want a UserService, you can either create an object based off this object if no additional functionality is needed like this: UserService=CreateObject("component", "coldbox.system.orm.hibernate.VirtualEntityService").init("User"); You can also use this virtual service as a template object and extend and override as needed. import coldbox.system.orm.hibernate.*; component extends="VirtualEntityService" UserService function init(){ // setup properties setEntityName('User'); setQueryCacheRegion( 'ORMService.defaultCache' ); setUseQueryCaching( false ); return this; } ----------------------------------------------------------------------->

Constructor Summary
`init(string entityname, [string queryCacheRegion], [boolean useQueryCaching])` Constructor

Method Summary
`string`	`GETENTITYNAME()` get: The entityName property for this "version" of the Virtual Service
`void`	`SETENTITYNAME(string entityName)` set: The entityName property for this "version" of the Virtual Service
`numeric`	`count([string where=''], [any params='[runtime expression]'])`
`numeric`	`countWhere()`
`boolean`	`deleteByID(any id, [boolean flush='false'])`
`numeric`	`deleteWhere()`
`void`	`evict([string collectionName], [any id])`
`boolean`	`exists(any id)`
`array`	`findAllWhere()`
`any`	`findWhere()`
`any`	`get(any id)`
`array`	`getAll([any id])`
`string`	`getKey()`
`array`	`getPropertyNames()`
`string`	`getTableName()`
`any`	`list([struct criteria='[runtime expression]'], [string sortOrder=''], [numeric offset='0'], [numeric max='0'], [numeric timeout='0'], [boolean ignoreCase='false'], [boolean asQuery='true'])`
`any`	`new()`

Methods inherited from class coldbox.system.orm.hibernate.BaseORMService
`GETQUERYCACHEREGION, GETUSEQUERYCACHING, SETQUERYCACHEREGION, SETUSEQUERYCACHING, clear, createService, delete, deleteByQuery, evictEntity, evictQueries, executeQuery, find, findAll, getSessionStatistics, isSessionDirty, merge, onMissingMethod, refresh, save, sessionContains`

Methods inherited from class WEB-INF.cftags.component

Constructor Detail

init

public init(string entityname, [string queryCacheRegion], [boolean useQueryCaching])

Constructor

Parameters:: entityname; queryCacheRegion; useQueryCaching

Method Detail

GETENTITYNAME

public string GETENTITYNAME()

get: The entityName property for this "version" of the Virtual Service

SETENTITYNAME

public void SETENTITYNAME(string entityName)

set: The entityName property for this "version" of the Virtual Service

count

public numeric count([string where=''], [any params='[runtime expression]'])

Overrides:: count in class BaseORMService

Parameters:: where; params

countWhere

public numeric countWhere()

Overrides:: countWhere in class BaseORMService

deleteByID

public boolean deleteByID(any id, [boolean flush='false'])

Overrides:: deleteByID in class BaseORMService

Parameters:: id; flush

deleteWhere

public numeric deleteWhere()

Overrides:: deleteWhere in class BaseORMService

evict

public void evict([string collectionName], [any id])

Overrides:: evict in class BaseORMService

Parameters:: collectionName; id

exists

public boolean exists(any id)

Overrides:: exists in class BaseORMService

Parameters:: id

findAllWhere

public array findAllWhere()

Overrides:: findAllWhere in class BaseORMService

findWhere

public any findWhere()

Overrides:: findWhere in class BaseORMService

get

public any get(any id)

Overrides:: get in class BaseORMService

Parameters:: id

getAll

public array getAll([any id])

Overrides:: getAll in class BaseORMService

Parameters:: id

getKey

public string getKey()

Overrides:: getKey in class BaseORMService

getPropertyNames

public array getPropertyNames()

Overrides:: getPropertyNames in class BaseORMService

getTableName

public string getTableName()

Overrides:: getTableName in class BaseORMService

list

public any list([struct criteria='[runtime expression]'], [string sortOrder=''], [numeric offset='0'], [numeric max='0'], [numeric timeout='0'], [boolean ignoreCase='false'], [boolean asQuery='true'])

Overrides:: list in class BaseORMService

Parameters:: criteria; sortOrder; offset; max; timeout; ignoreCase; asQuery

new

public any new()

Overrides:: new in class BaseORMService

Overview

Package