Package lucee.runtime.orm

Interface ORMSession

public interface ORMSession

Method Summary

Modifier and Type	Method	Description
void	clear(PageContext pc)	clear all elements in the default sessions
void	clear(PageContext pc, java.lang.String dataSource)	clear all elements in a specific sessions defined by datasource name
void	close(PageContext pc)	close all elements in the default sessions
void	close(PageContext pc, java.lang.String datasource)	close all elements in a specific sessions defined by datasource name
void	closeAll(PageContext pc)	close all elements in all sessions
Component	create(PageContext pc, java.lang.String entityName)	creates an entity matching the given name
void	delete(PageContext pc, java.lang.Object obj)	delete elememt from datasource
void	evictCollection(PageContext pc, java.lang.String entity, java.lang.String collection)
void	evictCollection(PageContext pc, java.lang.String entity, java.lang.String collection, java.lang.String id)
void	evictEntity(PageContext pc, java.lang.String entity)
void	evictEntity(PageContext pc, java.lang.String entity, java.lang.String id)
void	evictQueries(PageContext pc)
void	evictQueries(PageContext pc, java.lang.String cacheName)
void	evictQueries(PageContext pc, java.lang.String cacheName, java.lang.String datasource)
java.lang.Object	executeQuery(PageContext pc, java.lang.String dataSourceName, java.lang.String hql, Array params, boolean unique, Struct queryOptions)
java.lang.Object	executeQuery(PageContext pc, java.lang.String dataSourceName, java.lang.String hql, Struct params, boolean unique, Struct queryOptions)
void	flush(PageContext pc)	flush all elements in the default sessions
void	flush(PageContext pc, java.lang.String datasource)	flush all elements in a specific sessions defined by datasource name
void	flushAll(PageContext pc)	flush all elements in all sessions (for all datasources)
DataSource[]	getDataSources()
ORMEngine	getEngine()	engine from session
java.lang.String[]	getEntityNames()
java.lang.Object	getRawSession(java.lang.String dataSourceName)
java.lang.Object	getRawSessionFactory(java.lang.String dataSourceName)
ORMTransaction	getTransaction(java.lang.String dataSourceName, boolean autoManage)
boolean	isValid()
boolean	isValid(DataSource ds)	is session valid or not
Component	load(PageContext pc, java.lang.String name, java.lang.String id)	load and return an Object that match given id, if there is more than one Object matching the id, only the first Object is returned
Component	load(PageContext pc, java.lang.String name, Struct filter)	load and return an Object that match given filter, if there is more than one Object matching the filter, only the first Object is returned
Array	loadAsArray(PageContext pc, java.lang.String name, java.lang.String id)	load and return an Array of Objects matching given id
Array	loadAsArray(PageContext pc, java.lang.String name, java.lang.String id, java.lang.String order)
Array	loadAsArray(PageContext pc, java.lang.String name, Struct filter)	load and return an Array of Objects matching given filter
Array	loadAsArray(PageContext pc, java.lang.String name, Struct filter, Struct options)	load and return an Array of Objects matching given filter
Array	loadAsArray(PageContext pc, java.lang.String name, Struct filter, Struct options, java.lang.String order)
Component	loadByExample(PageContext pc, java.lang.Object obj)	load and return an Object that match given sampleEntity, if there is more than one Object matching the id, only the first Object is returned
Array	loadByExampleAsArray(PageContext pc, java.lang.Object obj)	load and return an Array of Objects matching given sampleEntity
Component	merge(PageContext pc, java.lang.Object obj)	Attaches the specified entity to the current ORM session.
void	reload(PageContext pc, java.lang.Object obj)	Reloads data for an entity that is already loaded.
void	save(PageContext pc, java.lang.Object obj, boolean forceInsert)	insert entity into datasource, even the entry already exist
Query	toQuery(PageContext pc, java.lang.Object obj, java.lang.String name)

Method Detail

flushAll

void flushAll(PageContext pc)
       throws PageException

flush all elements in all sessions (for all datasources)

Parameters:

pc -

Throws:

PageException

flush

void flush(PageContext pc)
    throws PageException

flush all elements in the default sessions

Parameters:

pc -

Throws:

PageException

flush

void flush(PageContext pc,
           java.lang.String datasource)
    throws PageException

flush all elements in a specific sessions defined by datasource name

Parameters:

pc -

Throws:

PageException

delete

void delete(PageContext pc,
            java.lang.Object obj)
     throws PageException

delete elememt from datasource

Parameters:

pc -

obj -

Throws:

PageException

save

void save(PageContext pc,
          java.lang.Object obj,
          boolean forceInsert)
   throws PageException

insert entity into datasource, even the entry already exist

Parameters:

pc -

obj -

forceInsert -

Throws:

PageException

reload

void reload(PageContext pc,
            java.lang.Object obj)
     throws PageException

Reloads data for an entity that is already loaded. This method refetches data from the database and repopulates the entity with the refreshed data.

Parameters:

obj -

Throws:

PageException

create

Component create(PageContext pc,
                 java.lang.String entityName)
          throws PageException

creates an entity matching the given name

Parameters:

entityName -

Returns:

Throws:

PageException

merge

Component merge(PageContext pc,
                java.lang.Object obj)
         throws PageException

Attaches the specified entity to the current ORM session. It copies the state of the given object onto the persistent object with the same identifier and returns the persistent object. If there is no persistent instance currently associated with the session, it is loaded. The given instance is not associated with the session. User have to use the returned object from this session.

Parameters:

pc -

obj -

Throws:

PageException

clear

void clear(PageContext pc)
    throws PageException

clear all elements in the default sessions

Parameters:

pc -

Throws:

PageException

clear

void clear(PageContext pc,
           java.lang.String dataSource)
    throws PageException

clear all elements in a specific sessions defined by datasource name

Parameters:

pc -

dataSource -

Throws:

PageException

load

Component load(PageContext pc,
               java.lang.String name,
               Struct filter)
        throws PageException

load and return an Object that match given filter, if there is more than one Object matching the filter, only the first Object is returned

Parameters:

name -

filter -

Returns:

Throws:

PageException

toQuery

Query toQuery(PageContext pc,
              java.lang.Object obj,
              java.lang.String name)
       throws PageException

Throws:

PageException

load

Component load(PageContext pc,
               java.lang.String name,
               java.lang.String id)
        throws PageException

load and return an Object that match given id, if there is more than one Object matching the id, only the first Object is returned

Parameters:

name -

id -

Throws:

PageException

loadAsArray

Array loadAsArray(PageContext pc,
                  java.lang.String name,
                  Struct filter)
           throws PageException

load and return an Array of Objects matching given filter

Parameters:

name -

filter -

Returns:

Throws:

PageException

loadAsArray

Array loadAsArray(PageContext pc,
                  java.lang.String name,
                  Struct filter,
                  Struct options)
           throws PageException

load and return an Array of Objects matching given filter

Parameters:

name -

filter -

options -

Returns:

Throws:

PageException

loadAsArray

Array loadAsArray(PageContext pc,
                  java.lang.String name,
                  Struct filter,
                  Struct options,
                  java.lang.String order)
           throws PageException

Parameters:

pc -

name -

filter -

options -

order -

Returns:

Throws:

PageException

loadAsArray

Array loadAsArray(PageContext pc,
                  java.lang.String name,
                  java.lang.String id)
           throws PageException

load and return an Array of Objects matching given id

Parameters:

name -

id -

Throws:

PageException

loadAsArray

Array loadAsArray(PageContext pc,
                  java.lang.String name,
                  java.lang.String id,
                  java.lang.String order)
           throws PageException

Parameters:

pc -

name -

id -

order -

Returns:

Throws:

PageException

loadByExampleAsArray

Array loadByExampleAsArray(PageContext pc,
                           java.lang.Object obj)
                    throws PageException

load and return an Array of Objects matching given sampleEntity

Parameters:

pc -

obj -

Throws:

PageException

loadByExample

Component loadByExample(PageContext pc,
                        java.lang.Object obj)
                 throws PageException

load and return an Object that match given sampleEntity, if there is more than one Object matching the id, only the first Object is returned

Parameters:

pc -

obj -

Throws:

PageException

evictCollection

void evictCollection(PageContext pc,
                     java.lang.String entity,
                     java.lang.String collection)
              throws PageException

Throws:

PageException

evictCollection

void evictCollection(PageContext pc,
                     java.lang.String entity,
                     java.lang.String collection,
                     java.lang.String id)
              throws PageException

Throws:

PageException

evictEntity

void evictEntity(PageContext pc,
                 java.lang.String entity)
          throws PageException

Throws:

PageException

evictEntity

void evictEntity(PageContext pc,
                 java.lang.String entity,
                 java.lang.String id)
          throws PageException

Throws:

PageException

evictQueries

void evictQueries(PageContext pc)
           throws PageException

Throws:

PageException

evictQueries

void evictQueries(PageContext pc,
                  java.lang.String cacheName)
           throws PageException

Throws:

PageException

evictQueries

void evictQueries(PageContext pc,
                  java.lang.String cacheName,
                  java.lang.String datasource)
           throws PageException

Throws:

PageException

executeQuery

java.lang.Object executeQuery(PageContext pc,
                              java.lang.String dataSourceName,
                              java.lang.String hql,
                              Array params,
                              boolean unique,
                              Struct queryOptions)
                       throws PageException

Throws:

PageException

executeQuery

java.lang.Object executeQuery(PageContext pc,
                              java.lang.String dataSourceName,
                              java.lang.String hql,
                              Struct params,
                              boolean unique,
                              Struct queryOptions)
                       throws PageException

Throws:

PageException

closeAll

void closeAll(PageContext pc)
       throws PageException

close all elements in all sessions

Parameters:

pc -

Throws:

PageException

close

void close(PageContext pc)
    throws PageException

close all elements in the default sessions

Parameters:

pc -

Throws:

PageException

close

void close(PageContext pc,
           java.lang.String datasource)
    throws PageException

close all elements in a specific sessions defined by datasource name

Parameters:

pc -

datasource -

Throws:

PageException

isValid

boolean isValid(DataSource ds)

is session valid or not

Returns:

is session valid

isValid

boolean isValid()

getEngine

ORMEngine getEngine()

engine from session

Returns:

engine

getRawSession

java.lang.Object getRawSession(java.lang.String dataSourceName)
                        throws PageException

Throws:

PageException

getRawSessionFactory

java.lang.Object getRawSessionFactory(java.lang.String dataSourceName)
                               throws PageException

Throws:

PageException

getTransaction

ORMTransaction getTransaction(java.lang.String dataSourceName,
                              boolean autoManage)
                       throws PageException

Throws:

PageException

getEntityNames

java.lang.String[] getEntityNames()

getDataSources

DataSource[] getDataSources()