com.communote.server.persistence.common.messages

Interface MessageDao

All Known Implementing Classes:

MessageDaoBase, MessageDaoImpl

public interface MessageDao

Author:

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

See Also:

Message

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<Message>	create(Collection<Message> entities) Creates a new instance of Message and adds from the passed in entities collection
Collection<?>	create(int transform, Collection<Message> entities) Does the same thing as create(com.communote.server.model.i18n.Message) with an additional flag called transform.
Object	create(int transform, Message message) Does the same thing as create(com.communote.server.model.i18n.Message) with an additional flag called transform.
Message	create(Message message) Creates an instance of Message and adds it to the persistent store.
void	evict(Message entity) Evicts (removes) the entity from the hibernate cache
Collection<Message>	find(String key) Returns a list of all messages for a specific key.
Message	find(String key, String languageCode) Returns the message for the key in the specific language or null if there is no one.
Message	find(String key, String languageCode, String fallbackLanguageCode) Returns the specified message.
Object	load(int transform, Long id) Does the same thing as load(Long) with an additional flag called transform.
Message	load(Long id) Loads an instance of Message from the persistent store.
Collection<Message>	loadAll() Loads all entities of type Message.
Collection<?>	loadAll(int transform) Does the same thing as loadAll() with an additional flag called transform.
void	remove(Collection<Message> entities) Removes all entities in the given entities collection.
void	remove(Long id) Removes the instance of Message having the given identifier from the persistent store.
void	remove(Message message) Removes the instance of Message from the persistent store.
void	update(Collection<Message> entities) Updates all instances in the entities collection in the persistent store.
void	update(Message message) Updates the message 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

Message create(Message message)

Creates an instance of Message and adds it to the persistent store.

create

Object create(int transform,
              Message message)

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

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

Creates a new instance of Message and adds from the passed in entities collection

Parameters:

entities - the collection of Message instances to create.

Returns:

the created instances.

evict

void evict(Message entity)

Evicts (removes) the entity from the hibernate cache

Parameters:

entity - the entity to evict

find

Collection<Message> find(String key)

Returns a list of all messages for a specific key.

find

Message find(String key,
             String languageCode)

Returns the message for the key in the specific language or null if there is no one.

find

Message find(String key,
             String languageCode,
             String fallbackLanguageCode)

Returns the specified message. Returns the message fallback if the original message was not found.

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

Message load(Long id)

Loads an instance of Message from the persistent store.

loadAll

Collection<Message> loadAll()

Loads all entities of type Message.

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(Message message)

Removes the instance of Message from the persistent store.

remove

void remove(Collection<Message> entities)

Removes all entities in the given entities collection.

remove

void remove(Long id)

Removes the instance of Message having the given identifier from the persistent store.

update

void update(Message message)

Updates the message instance in the persistent store.

update

void update(Collection<Message> entities)

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