com.communote.server.persistence.user

Interface UserNotePropertyDao

All Known Implementing Classes:

UserNotePropertyDaoBase, UserNotePropertyDaoImpl

public interface UserNotePropertyDao

Author:

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

See Also:

UserNoteProperty

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<UserNoteProperty>	create(Collection<UserNoteProperty> entities) Creates a new instance of com.communote.server.persistence.user.UserNoteProperty and adds from the passed in entities collection
Collection<?>	create(int transform, Collection<UserNoteProperty> entities) Does the same thing as create(com.communote.server.model.user.UserNoteProperty) with an additional flag called transform.
Object	create(int transform, UserNoteProperty userNoteProperty) Does the same thing as create(com.communote.server.model.user.UserNoteProperty) with an additional flag called transform.
UserNoteProperty	create(UserNoteProperty userNoteProperty) Creates an instance of com.communote.server.persistence.user.UserNoteProperty and adds it to the persistent store.
void	evict(UserNoteProperty entity) Evicts (removes) the entity from the hibernate cache
Collection<UserNoteProperty>	findProperties(Long noteId, String keyGroup, String key) Return a collection of matching user note properties.
UserNoteProperty	findProperty(Long noteId, String keyGroup, String key) Return the property with the given key group and key for the given note ID or null if the current user does not have such a property for that note.
Object	load(int transform, Long id) Does the same thing as load(Long) with an additional flag called transform.
UserNoteProperty	load(Long id) Loads an instance of com.communote.server.persistence.user.UserNoteProperty from the persistent store.
Collection<UserNoteProperty>	loadAll() Loads all entities of type UserNoteProperty.
Collection<?>	loadAll(int transform) Does the same thing as loadAll() with an additional flag called transform.
void	remove(Collection<UserNoteProperty> entities) Removes all entities in the given entities collection.
void	remove(Long id) Removes the instance of com.communote.server.persistence.user.UserNoteProperty having the given identifier from the persistent store.
void	remove(UserNoteProperty userNoteProperty) Removes the instance of com.communote.server.persistence.user.UserNoteProperty from the persistent store.
int	removePropertiesForNote(Long noteId) Remove all properties for the given note.
int	removePropertiesForUser(Long userId) Remove all properties for the given user.
void	update(Collection<UserNoteProperty> entities) Updates all instances in the entities collection in the persistent store.
void	update(UserNoteProperty userNoteProperty) Updates the userNoteProperty 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

UserNoteProperty create(UserNoteProperty userNoteProperty)

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

create

Object create(int transform,
              UserNoteProperty userNoteProperty)

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

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

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

Parameters:

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

Returns:

the created instances.

evict

void evict(UserNoteProperty entity)

Evicts (removes) the entity from the hibernate cache

Parameters:

entity - the entity to evict

findProperties

Collection<UserNoteProperty> findProperties(Long noteId,
                                            String keyGroup,
                                            String key)

Return a collection of matching user note properties. This will consider all users and include their property for a given note if it has the provided group and key.

findProperty

UserNoteProperty findProperty(Long noteId,
                              String keyGroup,
                              String key)

Return the property with the given key group and key for the given note ID or null if the current user does not have such a property for that note.

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

UserNoteProperty load(Long id)

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

loadAll

Collection<UserNoteProperty> loadAll()

Loads all entities of type UserNoteProperty.

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(UserNoteProperty userNoteProperty)

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

remove

void remove(Collection<UserNoteProperty> entities)

Removes all entities in the given entities collection.

remove

void remove(Long id)

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

removePropertiesForNote

int removePropertiesForNote(Long noteId)

Remove all properties for the given note. This method should only be called by the UserNotePropertyAccessor.

Parameters:

noteId - the ID of the note

Returns:

the number of removed properties.

removePropertiesForUser

int removePropertiesForUser(Long userId)

Remove all properties for the given user.

Parameters:

userId - the ID of the user

Returns:

the number of removed properties.

update

void update(UserNoteProperty userNoteProperty)

Updates the userNoteProperty instance in the persistent store.

update

void update(Collection<UserNoteProperty> entities)

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