org.broadleafcommerce.common.dao

Interface GenericEntityDao

All Known Implementing Classes:

GenericEntityDaoImpl

public interface GenericEntityDao

Provides methods to easily access entities managed by the 'blPU' PersistenceUnit.

Method Summary

Modifier and Type	Method and Description
void	clear() Clear level 1 cache
void	clearAutoFlushMode()
void	enableAutoFlushMode()
void	flush() Flush changes to the persistence store
Class<?>	getCeilingImplClass(String className) Finds the ceiling implementation for the entity
javax.persistence.EntityManager	getEntityManager() Gathers the EntityManager that is based on blPU
Serializable	getIdentifier(Object entity) Retrieve the identifier from the Hibernate entity (the entity must reside in the current session)
Class<?>	getImplClass(String className) For a given className, finds the parent implementation class as defined in the EntityConfiguration
boolean	idAssigned(Object object) Whether or not this object is an Entity and whether or not it already has an id assigned
void	persist(Object object) Persist the new entity
<T> List<T>	readAllGenericEntity(Class<T> clazz)
<T> List<T>	readAllGenericEntity(Class<T> clazz, int limit, int offset) Finds all generic entities for a given classname, with pagination options.
List<Long>	readAllGenericEntityId(Class<?> clazz)
<T> Long	readCountGenericEntity(Class<T> clazz) Finds how many of the given entity class are persisted
<T> T	readGenericEntity(Class<T> clazz, Object id) Finds a generic entity by a classname and id
void	remove(Object object) Remove the entity
<T> T	save(T object) Saves a generic entity
boolean	sessionContains(Object object) Whether or not the current hibernate session (level 1) contains the object

Method Detail

readGenericEntity

<T> T readGenericEntity(Class<T> clazz,
                        Object id)

Finds a generic entity by a classname and id

Parameters:

clazz -

id -

Returns:

the entity

getImplClass

Class<?> getImplClass(String className)

For a given className, finds the parent implementation class as defined in the EntityConfiguration

Parameters:

className -

Returns:

the impl class object

getCeilingImplClass

Class<?> getCeilingImplClass(String className)

Finds the ceiling implementation for the entity

Parameters:

className -

Returns:

save

<T> T save(T object)

Saves a generic entity

Parameters:

object -

Returns:

the persisted version of the entity

persist

void persist(Object object)

Persist the new entity

Parameters:

object -

remove

void remove(Object object)

Remove the entity

Parameters:

object -

readCountGenericEntity

<T> Long readCountGenericEntity(Class<T> clazz)

Finds how many of the given entity class are persisted

Parameters:

clazz -

Returns:

the count of the generic entity

readAllGenericEntity

<T> List<T> readAllGenericEntity(Class<T> clazz,
                                 int limit,
                                 int offset)

Finds all generic entities for a given classname, with pagination options.

Parameters:

clazz -

limit -

offset -

Returns:

the entities

readAllGenericEntity

<T> List<T> readAllGenericEntity(Class<T> clazz)

readAllGenericEntityId

List<Long> readAllGenericEntityId(Class<?> clazz)

getIdentifier

Serializable getIdentifier(Object entity)

Retrieve the identifier from the Hibernate entity (the entity must reside in the current session)

Parameters:

entity -

Returns:

flush

void flush()

Flush changes to the persistence store

clearAutoFlushMode

void clearAutoFlushMode()

enableAutoFlushMode

void enableAutoFlushMode()

clear

void clear()

Clear level 1 cache

sessionContains

boolean sessionContains(Object object)

Whether or not the current hibernate session (level 1) contains the object

Parameters:

object -

Returns:

idAssigned

boolean idAssigned(Object object)

Whether or not this object is an Entity and whether or not it already has an id assigned

Parameters:

object -

Returns:

getEntityManager

javax.persistence.EntityManager getEntityManager()

Gathers the EntityManager that is based on blPU

Returns:

the EntityManager