com.communote.server.persistence.blog

Interface UserToBlogRoleMappingDao

All Known Implementing Classes:

UserToBlogRoleMappingDaoBase, UserToBlogRoleMappingDaoImpl

public interface UserToBlogRoleMappingDao

Author:

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

See Also:

UserToBlogRoleMapping

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<UserToBlogRoleMapping>	create(Collection<UserToBlogRoleMapping> entities) Creates a new instance of com.communote.server.persistence.blog.UserToBlogRoleMapping and adds from the passed in entities collection
Collection<?>	create(int transform, Collection<UserToBlogRoleMapping> entities) Does the same thing as create(com.communote.server.model.blog.UserToBlogRoleMapping) with an additional flag called transform.
Object	create(int transform, UserToBlogRoleMapping userToBlogRoleMapping) Does the same thing as create(com.communote.server.model.blog.UserToBlogRoleMapping) with an additional flag called transform.
UserToBlogRoleMapping	create(UserToBlogRoleMapping userToBlogRoleMapping) Creates an instance of com.communote.server.persistence.blog.UserToBlogRoleMapping and adds it to the persistent store.
void	evict(UserToBlogRoleMapping entity) Evicts (removes) the entity from the hibernate cache
Collection<UserToBlogRoleMapping>	findMappings(Long blogId, Long userId, Long groupId, Boolean grantedByGroup, BlogRole role) Retrieves mappings matching the parameters.
Collection<UserToBlogRoleMapping>	findMappingsForExternal(Long blogId, Long userId, Long groupId, boolean grantedByGroup, BlogRole role, String externalSystemId) Retrieves mappings matching the parameters.
BlogRole	getRoleOfUser(Long blogId, Long userId) Returns the role of the user for the blog or null if the user has no role for the blog.
Object	load(int transform, Long id) Does the same thing as load(Long) with an additional flag called transform.
UserToBlogRoleMapping	load(Long id) Loads an instance of com.communote.server.persistence.blog.UserToBlogRoleMapping from the persistent store.
Collection<UserToBlogRoleMapping>	loadAll() Loads all entities of type UserToBlogRoleMapping.
Collection<?>	loadAll(int transform) Does the same thing as loadAll() with an additional flag called transform.
void	remove(Collection<UserToBlogRoleMapping> entities) Removes all entities in the given entities collection.
void	remove(Long id) Removes the instance of com.communote.server.persistence.blog.UserToBlogRoleMapping having the given identifier from the persistent store.
void	remove(UserToBlogRoleMapping userToBlogRoleMapping) Removes the instance of com.communote.server.persistence.blog.UserToBlogRoleMapping from the persistent store.
void	removeAllForBlog(Long blogId) Removes all entries for one blog.
void	removeAllForGroup(Long groupId)
void	removeAllForGroupMember(Long userId, Long groupId) Removes all entries for group member.
void	update(Collection<UserToBlogRoleMapping> entities) Updates all instances in the entities collection in the persistent store.
void	update(UserToBlogRoleMapping userToBlogRoleMapping) Updates the userToBlogRoleMapping 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

UserToBlogRoleMapping create(UserToBlogRoleMapping userToBlogRoleMapping)

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

create

Object create(int transform,
              UserToBlogRoleMapping userToBlogRoleMapping)

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

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

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

Parameters:

entities - the collection of com.communote.server.persistence.blog.UserToBlogRoleMapping instances to create.

Returns:

the created instances.

evict

void evict(UserToBlogRoleMapping entity)

Evicts (removes) the entity from the hibernate cache

Parameters:

entity - the entity to evict

findMappings

Collection<UserToBlogRoleMapping> findMappings(Long blogId,
                                               Long userId,
                                               Long groupId,
                                               Boolean grantedByGroup,
                                               BlogRole role)

Retrieves mappings matching the parameters. The externalSystemId is ignored.

Parameters:

grantedByGroup - whether the mappings should be granted by a group. If null this doesn't matter, set to true or false to explicitly include this filter.

findMappingsForExternal

Collection<UserToBlogRoleMapping> findMappingsForExternal(Long blogId,
                                                          Long userId,
                                                          Long groupId,
                                                          boolean grantedByGroup,
                                                          BlogRole role,
                                                          String externalSystemId)

Retrieves mappings matching the parameters. The external system ID is respected.

getRoleOfUser

BlogRole getRoleOfUser(Long blogId,
                       Long userId)

Returns the role of the user for the blog or null if the user has no role for the blog.

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

UserToBlogRoleMapping load(Long id)

Loads an instance of com.communote.server.persistence.blog.UserToBlogRoleMapping from the persistent store.

loadAll

Collection<UserToBlogRoleMapping> loadAll()

Loads all entities of type UserToBlogRoleMapping.

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(UserToBlogRoleMapping userToBlogRoleMapping)

Removes the instance of com.communote.server.persistence.blog.UserToBlogRoleMapping from the persistent store.

remove

void remove(Collection<UserToBlogRoleMapping> entities)

Removes all entities in the given entities collection.

remove

void remove(Long id)

Removes the instance of com.communote.server.persistence.blog.UserToBlogRoleMapping having the given identifier from the persistent store.

removeAllForBlog

void removeAllForBlog(Long blogId)

Removes all entries for one blog.

removeAllForGroup

void removeAllForGroup(Long groupId)

removeAllForGroupMember

void removeAllForGroupMember(Long userId,
                             Long groupId)

Removes all entries for group member.

update

void update(UserToBlogRoleMapping userToBlogRoleMapping)

Updates the userToBlogRoleMapping instance in the persistent store.

update

void update(Collection<UserToBlogRoleMapping> entities)

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