com.communote.server.persistence.user

Interface UserProfileDao

All Known Implementing Classes:

UserProfileDaoBase, UserProfileDaoImpl

public interface UserProfileDao

Author:

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

See Also:

UserProfile

Field Summary

Fields

Modifier and Type	Field and Description
static int	TRANSFORM_KENMEIUSERPROFILEVO This constant is used as a transformation flag; entities can be converted automatically into value objects or other types, different methods in a class implementing this interface support this feature: look for an int parameter called transform.
static int	TRANSFORM_NONE This constant is used as a transformation flag; entities can be converted automatically into value objects or other types, different methods in a class implementing this interface support this feature: look for an int parameter called transform.

Method Summary

Modifier and Type	Method and Description
Collection<UserProfile>	create(Collection<UserProfile> entities) Creates a new instance of com.communote.server.persistence.user.KenmeiUserProfile and adds from the passed in entities collection
Collection<?>	create(int transform, Collection<UserProfile> entities) Does the same thing as create(com.communote.server.model.user.UserProfile) with an additional flag called transform.
Object	create(int transform, UserProfile kenmeiUserProfile) Does the same thing as create(com.communote.server.model.user.UserProfile) with an additional flag called transform.
UserProfile	create(UserProfile kenmeiUserProfile) Creates an instance of com.communote.server.persistence.user.KenmeiUserProfile and adds it to the persistent store.
void	evict(UserProfile entity) Evicts (removes) the entity from the hibernate cache
void	kenmeiUserProfileVOToEntityCollection(Collection instances) Converts a Collection of instances of type UserProfileVO to this DAO's entity.
Object	load(int transform, Long id) Does the same thing as load(Long) with an additional flag called transform.
UserProfile	load(Long id) Loads an instance of com.communote.server.persistence.user.KenmeiUserProfile from the persistent store.
Collection<UserProfile>	loadAll() Loads all entities of type UserProfile.
Collection<?>	loadAll(int transform) Does the same thing as loadAll() with an additional flag called transform.
void	remove(Collection<UserProfile> entities) Removes all entities in the given entities collection.
void	remove(Long id) Removes the instance of com.communote.server.persistence.user.KenmeiUserProfile having the given identifier from the persistent store.
void	remove(UserProfile kenmeiUserProfile) Removes the instance of com.communote.server.persistence.user.KenmeiUserProfile from the persistent store.
void	toKenmeiUserProfileVOCollection(Collection entities) Converts this DAO's entity to a Collection of instances of type UserProfileVO.
UserProfileVO	toUserProfileVO(UserProfile entity) Converts this DAO's entity to an object of type UserProfileVO.
void	toUserProfileVO(UserProfile source, UserProfileVO target) Copies the fields of the specified entity to the target value object.
void	update(Collection<UserProfile> entities) Updates all instances in the entities collection in the persistent store.
void	update(UserProfile kenmeiUserProfile) Updates the kenmeiUserProfile instance in the persistent store.
UserProfile	userProfileVOToEntity(UserProfileVO kenmeiUserProfileVO) Converts an instance of type UserProfileVO to this DAO's entity.
void	userProfileVOToEntity(UserProfileVO source, UserProfile target, boolean copyIfNull) Copies the fields of UserProfileVO to the specified entity.

Field Detail

TRANSFORM_NONE

static final int TRANSFORM_NONE

This constant is used as a transformation flag; entities can be converted automatically into value objects or other types, different methods in a class implementing this interface support this feature: look for an int parameter called transform.

This specific flag denotes no transformation will occur.

See Also:

Constant Field Values

TRANSFORM_KENMEIUSERPROFILEVO

static final int TRANSFORM_KENMEIUSERPROFILEVO

This constant is used as a transformation flag; entities can be converted automatically into value objects or other types, different methods in a class implementing this interface support this feature: look for an int parameter called transform.

This specific flag denotes entities must be transformed into objects of type UserProfileVO.

See Also:

Constant Field Values

Method Detail

create

UserProfile create(UserProfile kenmeiUserProfile)

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

create

Object create(int transform,
              UserProfile kenmeiUserProfile)

Does the same thing as create(com.communote.server.model.user.UserProfile) 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.

create

Collection<?> create(int transform,
                     Collection<UserProfile> entities)

Does the same thing as create(com.communote.server.model.user.UserProfile) 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.

create

Collection<UserProfile> create(Collection<UserProfile> entities)

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

Parameters:

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

Returns:

the created instances.

evict

void evict(UserProfile entity)

Evicts (removes) the entity from the hibernate cache

Parameters:

entity - the entity to evict

kenmeiUserProfileVOToEntityCollection

void kenmeiUserProfileVOToEntityCollection(Collection instances)

Converts a Collection of instances of type UserProfileVO to this DAO's entity.

load

Object load(int transform,
            Long id)

Does the same thing as 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.

Parameters:

id - the identifier of the entity to load.

Returns:

either the entity or the object transformed from the entity.

load

UserProfile load(Long id)

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

loadAll

Collection<UserProfile> loadAll()

Loads all entities of type UserProfile.

Returns:

the loaded entities.

loadAll

Collection<?> loadAll(int transform)

Does the same thing as 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.

Parameters:

transform - the flag indicating what transformation to use.

Returns:

the loaded entities.

remove

void remove(UserProfile kenmeiUserProfile)

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

remove

void remove(Collection<UserProfile> entities)

Removes all entities in the given entities collection.

remove

void remove(Long id)

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

toKenmeiUserProfileVOCollection

void toKenmeiUserProfileVOCollection(Collection entities)

Converts this DAO's entity to a Collection of instances of type UserProfileVO.

toUserProfileVO

UserProfileVO toUserProfileVO(UserProfile entity)

Converts this DAO's entity to an object of type UserProfileVO.

toUserProfileVO

void toUserProfileVO(UserProfile source,
                     UserProfileVO target)

Copies the fields of the specified entity to the target value object. This method is similar to toKenmeiUserProfileVO(), but it does not handle any attributes in the target value object that are "read-only" (as those do not have setter methods exposed).

update

void update(UserProfile kenmeiUserProfile)

Updates the kenmeiUserProfile instance in the persistent store.

update

void update(Collection<UserProfile> entities)

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

userProfileVOToEntity

UserProfile userProfileVOToEntity(UserProfileVO kenmeiUserProfileVO)

Converts an instance of type UserProfileVO to this DAO's entity.

userProfileVOToEntity

void userProfileVOToEntity(UserProfileVO source,
                           UserProfile target,
                           boolean copyIfNull)

Copies the fields of UserProfileVO to the specified entity.

Parameters:

copyIfNull - If FALSE, the value object's field will not be copied to the entity if the value is NULL. If TRUE, it will be copied regardless of its value.