com.communote.server.persistence.user.security

Class UserSecurityCodeDaoBase

java.lang.Object

org.springframework.dao.support.DaoSupport

org.springframework.orm.hibernate3.support.HibernateDaoSupport

com.communote.server.persistence.user.security.UserSecurityCodeDaoBase

All Implemented Interfaces:

UserSecurityCodeDao, org.springframework.beans.factory.InitializingBean

Direct Known Subclasses:

UserSecurityCodeDaoImpl

public abstract class UserSecurityCodeDaoBase
extends org.springframework.orm.hibernate3.support.HibernateDaoSupport
implements UserSecurityCodeDao

Base Spring DAO Class: is able to create, update, remove, load, and find objects of type com.communote.server.persistence.user.security.UserSecurityCode.

Author:

Communote GmbH - http://www.communote.com/

See Also:

UserSecurityCode

Field Summary

Fields inherited from class org.springframework.dao.support.DaoSupport

logger

Fields inherited from interface com.communote.server.persistence.user.security.UserSecurityCodeDao

TRANSFORM_NONE

Constructor Summary

Constructors

Constructor and Description
UserSecurityCodeDaoBase()

Method Summary

Modifier and Type	Method and Description
Collection<UserSecurityCode>	create(Collection<UserSecurityCode> entities) Creates a new instance of com.communote.server.persistence.user.security.UserSecurityCode and adds from the passed in entities collection
Collection<UserSecurityCode>	create(int transform, Collection<UserSecurityCode> entities) Does the same thing as UserSecurityCodeDao.create(com.communote.server.model.user.security.UserSecurityCode) with an additional flag called transform.
Object	create(int transform, UserSecurityCode userSecurityCode) Does the same thing as UserSecurityCodeDao.create(com.communote.server.model.user.security.UserSecurityCode) with an additional flag called transform.
UserSecurityCode	create(UserSecurityCode userSecurityCode) Creates an instance of com.communote.server.persistence.user.security.UserSecurityCode and adds it to the persistent store.
UserSecurityCode	createCode(User user) Creates an user security code
void	evict(UserSecurityCode entity) Evicts (removes) the entity from the hibernate cache
UserSecurityCode	findBySecurityCode(String code) Finds the SecurityCode by the code.
UserSecurityCode	findByUser(Long userId, SecurityCodeAction action) Finds a code for an given user
protected SecurityCodeDao	getSecurityCodeDao() Gets the reference to securityCodeDao.
protected abstract UserSecurityCode	handleCreateCode(User user) Performs the core logic for createCode(com.communote.server.model.user.User)
protected abstract UserSecurityCode	handleFindBySecurityCode(String code) Performs the core logic for findBySecurityCode(String)
protected abstract UserSecurityCode	handleFindByUser(Long userId, SecurityCodeAction action) Performs the core logic for findByUser(Long, com.communote.server.model.security.SecurityCodeAction)
Object	load(int transform, Long id) Does the same thing as UserSecurityCodeDao.load(Long) with an additional flag called transform.
UserSecurityCode	load(Long id) Loads an instance of com.communote.server.persistence.user.security.UserSecurityCode from the persistent store.
Collection<UserSecurityCode>	loadAll() Loads all entities of type UserSecurityCode.
Collection<?>	loadAll(int transform) Does the same thing as UserSecurityCodeDao.loadAll() with an additional flag called transform.
void	remove(Collection<UserSecurityCode> entities) Removes all entities in the given entities collection.
void	remove(Long id) Removes the instance of com.communote.server.persistence.user.security.UserSecurityCode having the given identifier from the persistent store.
void	remove(UserSecurityCode userSecurityCode) Removes the instance of com.communote.server.persistence.user.security.UserSecurityCode from the persistent store.
void	setSecurityCodeDao(SecurityCodeDao securityCodeDao) Sets the reference to securityCodeDao.
protected void	transformEntities(int transform, Collection<?> entities) Transforms a collection of entities using the transformEntity(int,com.communote.server.model.user.security.UserSecurityCode) method.
protected Object	transformEntity(int transform, UserSecurityCode entity) Allows transformation of entities into value objects (or something else for that matter), when the transform flag is set to one of the constants defined in com.communote.server.persistence.user.security.UserSecurityCodeDao, please note that the UserSecurityCodeDao.TRANSFORM_NONE constant denotes no transformation, so the entity itself will be returned.
void	update(Collection<UserSecurityCode> entities) Updates all instances in the entities collection in the persistent store.
void	update(UserSecurityCode userSecurityCode) Updates the userSecurityCode instance in the persistent store.

Methods inherited from class org.springframework.orm.hibernate3.support.HibernateDaoSupport

checkDaoConfig, convertHibernateAccessException, createHibernateTemplate, getHibernateTemplate, getSession, getSession, getSessionFactory, releaseSession, setHibernateTemplate, setSessionFactory

Methods inherited from class org.springframework.dao.support.DaoSupport

afterPropertiesSet, initDao

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UserSecurityCodeDaoBase

public UserSecurityCodeDaoBase()

Method Detail

create

public UserSecurityCode create(UserSecurityCode userSecurityCode)

Description copied from interface: UserSecurityCodeDao

Creates an instance of com.communote.server.persistence.user.security.UserSecurityCode and adds it to the persistent store.

Specified by:

create in interface UserSecurityCodeDao

See Also:

UserSecurityCodeDao.create(com.communote.server.model.user.security.UserSecurityCode)

create

public Object create(int transform,
                     UserSecurityCode userSecurityCode)

Description copied from interface: UserSecurityCodeDao

Does the same thing as UserSecurityCodeDao.create(com.communote.server.model.user.security.UserSecurityCode) with an additional flag called transform. If this flag is set to TRANSFORM_NONE then the returned entity will NOT be transformed. If this flag is any of the other constants defined here then the result WILL BE passed through an operation which can optionally transform the entity (into a value object for example). By default, transformation does not occur.

Specified by:

create in interface UserSecurityCodeDao

See Also:

com.communote.server.persistence.user.security.UserSecurityCodeDao#create(int transform, com.communote.server.persistence.user.security.UserSecurityCode)

create

public Collection<UserSecurityCode> create(int transform,
                                           Collection<UserSecurityCode> entities)

Description copied from interface: UserSecurityCodeDao

Does the same thing as UserSecurityCodeDao.create(com.communote.server.model.user.security.UserSecurityCode) with an additional flag called transform. If this flag is set to TRANSFORM_NONE then the returned entity will NOT be transformed. If this flag is any of the other constants defined here then the result WILL BE passed through an operation which can optionally transform the entities (into value objects for example). By default, transformation does not occur.

Specified by:

create in interface UserSecurityCodeDao

See Also:

com.communote.server.persistence.user.security.UserSecurityCodeDao#create(int, java.util.Collection)

create

public Collection<UserSecurityCode> create(Collection<UserSecurityCode> entities)

Description copied from interface: UserSecurityCodeDao

Creates a new instance of com.communote.server.persistence.user.security.UserSecurityCode and adds from the passed in entities collection

Specified by:

create in interface UserSecurityCodeDao

Parameters:

entities - the collection of com.communote.server.persistence.user.security.UserSecurityCode instances to create.

Returns:

the created instances.

See Also:

com.communote.server.persistence.user.security.UserSecurityCodeDao#create(java.util. Collection)

createCode

public UserSecurityCode createCode(User user)

Description copied from interface: UserSecurityCodeDao

Creates an user security code

Specified by:

createCode in interface UserSecurityCodeDao

See Also:

UserSecurityCodeDao.createCode(com.communote.server.model.user.User)

evict

public void evict(UserSecurityCode entity)

Evicts (removes) the entity from the hibernate cache

Specified by:

evict in interface UserSecurityCodeDao

Parameters:

entity - the entity to evict

findBySecurityCode

public UserSecurityCode findBySecurityCode(String code)

Description copied from interface: UserSecurityCodeDao

Finds the SecurityCode by the code.

Specified by:

findBySecurityCode in interface UserSecurityCodeDao

See Also:

UserSecurityCodeDao.findBySecurityCode(String)

findByUser

public UserSecurityCode findByUser(Long userId,
                                   SecurityCodeAction action)

Description copied from interface: UserSecurityCodeDao

Finds a code for an given user

Specified by:

findByUser in interface UserSecurityCodeDao

See Also:

UserSecurityCodeDao.findByUser(Long, com.communote.server.model.security.SecurityCodeAction)

getSecurityCodeDao

protected SecurityCodeDao getSecurityCodeDao()

Gets the reference to securityCodeDao.

handleCreateCode

protected abstract UserSecurityCode handleCreateCode(User user)

Performs the core logic for createCode(com.communote.server.model.user.User)

handleFindBySecurityCode

protected abstract UserSecurityCode handleFindBySecurityCode(String code)

Performs the core logic for findBySecurityCode(String)

handleFindByUser

protected abstract UserSecurityCode handleFindByUser(Long userId,
                                                     SecurityCodeAction action)

Performs the core logic for findByUser(Long, com.communote.server.model.security.SecurityCodeAction)

load

public Object load(int transform,
                   Long id)

Description copied from interface: UserSecurityCodeDao

Does the same thing as UserSecurityCodeDao.load(Long) with an additional flag called transform. If this flag is set to TRANSFORM_NONE then the returned entity will NOT be transformed. If this flag is any of the other constants defined in this class then the result WILL BE passed through an operation which can optionally transform the entity (into a value object for example). By default, transformation does not occur.

Specified by:

load in interface UserSecurityCodeDao

id - the identifier of the entity to load.

Returns:

either the entity or the object transformed from the entity.

See Also:

UserSecurityCodeDao.load(int, Long)

load

public UserSecurityCode load(Long id)

Description copied from interface: UserSecurityCodeDao

Loads an instance of com.communote.server.persistence.user.security.UserSecurityCode from the persistent store.

Specified by:

load in interface UserSecurityCodeDao

See Also:

UserSecurityCodeDao.load(Long)

loadAll

public Collection<UserSecurityCode> loadAll()

Description copied from interface: UserSecurityCodeDao

Loads all entities of type UserSecurityCode.

Specified by:

loadAll in interface UserSecurityCodeDao

Returns:

the loaded entities.

See Also:

UserSecurityCodeDao.loadAll()

loadAll

public Collection<?> loadAll(int transform)

Description copied from interface: UserSecurityCodeDao

Does the same thing as UserSecurityCodeDao.loadAll() with an additional flag called transform. If this flag is set to TRANSFORM_NONE then the returned entity will NOT be transformed. If this flag is any of the other constants defined here then the result WILL BE passed through an operation which can optionally transform the entity (into a value object for example). By default, transformation does not occur.

Specified by:

loadAll in interface UserSecurityCodeDao

Parameters:

transform - the flag indicating what transformation to use.

Returns:

the loaded entities.

See Also:

UserSecurityCodeDao.loadAll(int)

remove

public void remove(UserSecurityCode userSecurityCode)

Description copied from interface: UserSecurityCodeDao

Removes the instance of com.communote.server.persistence.user.security.UserSecurityCode from the persistent store.

Specified by:

remove in interface UserSecurityCodeDao

See Also:

UserSecurityCodeDao.remove(com.communote.server.model.user.security.UserSecurityCode)

remove

public void remove(Collection<UserSecurityCode> entities)

Description copied from interface: UserSecurityCodeDao

Removes all entities in the given entities collection.

Specified by:

remove in interface UserSecurityCodeDao

See Also:

com.communote.server.persistence.user.security.UserSecurityCodeDao#remove(java.util. Collection)

remove

public void remove(Long id)

Description copied from interface: UserSecurityCodeDao

Removes the instance of com.communote.server.persistence.user.security.UserSecurityCode having the given identifier from the persistent store.

Specified by:

remove in interface UserSecurityCodeDao

See Also:

UserSecurityCodeDao.remove(Long)

setSecurityCodeDao

public void setSecurityCodeDao(SecurityCodeDao securityCodeDao)

Sets the reference to securityCodeDao.

transformEntities

protected void transformEntities(int transform,
                                 Collection<?> entities)

Transforms a collection of entities using the transformEntity(int,com.communote.server.model.user.security.UserSecurityCode) method. This method does not instantiate a new collection.

This method is to be used internally only.

Parameters:

transform - one of the constants declared in com.communote.server.persistence.user.security.UserSecurityCodeDao

entities - the collection of entities to transform

See Also:

transformEntity(int,com.communote.server.model.user.security.UserSecurityCode)

transformEntity

protected Object transformEntity(int transform,
                                 UserSecurityCode entity)

Allows transformation of entities into value objects (or something else for that matter), when the transform flag is set to one of the constants defined in com.communote.server.persistence.user.security.UserSecurityCodeDao, please note that the UserSecurityCodeDao.TRANSFORM_NONE constant denotes no transformation, so the entity itself will be returned. If the integer argument value is unknown UserSecurityCodeDao.TRANSFORM_NONE is assumed.

Parameters:

transform - one of the constants declared in UserSecurityCodeDao

entity - an entity that was found

Returns:

the transformed entity (i.e. new value object, etc)

See Also:

transformEntities(int,java.util.Collection)

update

public void update(UserSecurityCode userSecurityCode)

Description copied from interface: UserSecurityCodeDao

Updates the userSecurityCode instance in the persistent store.

Specified by:

update in interface UserSecurityCodeDao

See Also:

UserSecurityCodeDao.update(com.communote.server.model.user.security.UserSecurityCode)

update

public void update(Collection<UserSecurityCode> entities)

Description copied from interface: UserSecurityCodeDao

Updates all instances in the entities collection in the persistent store.

Specified by:

update in interface UserSecurityCodeDao

See Also:

com.communote.server.persistence.user.security.UserSecurityCodeDao#update(java.util. Collection)