com.communote.server.persistence.user.group

Interface UserOfGroupDao

All Known Implementing Classes:

UserOfGroupDaoBase, UserOfGroupDaoImpl

public interface UserOfGroupDao

Author:

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

See Also:

UserOfGroup

Field Summary

Fields

Modifier and Type	Field and Description
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<UserOfGroup>	create(Collection<UserOfGroup> entities) Creates a new instance of com.communote.server.persistence.user.group.UserOfGroup and adds from the passed in entities collection
Collection<?>	create(int transform, Collection<UserOfGroup> entities) Does the same thing as create(com.communote.server.model.user.group.UserOfGroup) with an additional flag called transform.
Object	create(int transform, UserOfGroup userOfGroup) Does the same thing as create(com.communote.server.model.user.group.UserOfGroup) with an additional flag called transform.
UserOfGroup	create(UserOfGroup userOfGroup) Creates an instance of com.communote.server.persistence.user.group.UserOfGroup and adds it to the persistent store.
void	evict(UserOfGroup entity) Evicts (removes) the entity from the hibernate cache
UserOfGroup	findByUserIdGroupId(Long userId, Long groupId) Returns a UserOfGroup entity identified by the userId and groupId.
Collection<UserOfGroup>	getUserOfGroupEntities(UserOfGroupModificationType modificationType) Returns the UserOfGroup entities that have the provided UserOfGroupModificationType.
Collection<Long>	getUsersOfGroup(Long groupId) Returns for a given group all users participating in the UserOfGroup association.
boolean	isUserOfGroup(Long userId, Long groupId) Tests wether there is an association between the user and the group.
Object	load(int transform, Long id) Does the same thing as load(Long) with an additional flag called transform.
UserOfGroup	load(Long id) Loads an instance of com.communote.server.persistence.user.group.UserOfGroup from the persistent store.
Collection<UserOfGroup>	loadAll() Loads all entities of type UserOfGroup.
Collection<?>	loadAll(int transform) Does the same thing as loadAll() with an additional flag called transform.
void	remove(Collection<UserOfGroup> entities) Removes all entities in the given entities collection.
void	remove(Long id) Removes the instance of com.communote.server.persistence.user.group.UserOfGroup having the given identifier from the persistent store.
void	remove(UserOfGroup userOfGroup) Removes the instance of com.communote.server.persistence.user.group.UserOfGroup from the persistent store.
void	update(Collection<UserOfGroup> entities) Updates all instances in the entities collection in the persistent store.
void	update(UserOfGroup userOfGroup) Updates the userOfGroup instance in the persistent store.

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

Method Detail

create

UserOfGroup create(UserOfGroup userOfGroup)

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

create

Object create(int transform,
              UserOfGroup userOfGroup)

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

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

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

Parameters:

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

Returns:

the created instances.

evict

void evict(UserOfGroup entity)

Evicts (removes) the entity from the hibernate cache

Parameters:

entity - the entity to evict

findByUserIdGroupId

UserOfGroup findByUserIdGroupId(Long userId,
                                Long groupId)

Returns a UserOfGroup entity identified by the userId and groupId.

getUserOfGroupEntities

Collection<UserOfGroup> getUserOfGroupEntities(UserOfGroupModificationType modificationType)

Returns the UserOfGroup entities that have the provided UserOfGroupModificationType. If the modification type is null the entities having null as modification type value are retrieved.

getUsersOfGroup

Collection<Long> getUsersOfGroup(Long groupId)

Returns for a given group all users participating in the UserOfGroup association. The return value will be a collection of user IDs.

isUserOfGroup

boolean isUserOfGroup(Long userId,
                      Long groupId)

Tests wether there is an association between the user and the group.

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

UserOfGroup load(Long id)

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

loadAll

Collection<UserOfGroup> loadAll()

Loads all entities of type UserOfGroup.

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(UserOfGroup userOfGroup)

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

remove

void remove(Collection<UserOfGroup> entities)

Removes all entities in the given entities collection.

remove

void remove(Long id)

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

update

void update(UserOfGroup userOfGroup)

Updates the userOfGroup instance in the persistent store.

update

void update(Collection<UserOfGroup> entities)

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