info.magnolia.ui.framework.message

Class MessageStore

java.lang.Object

info.magnolia.ui.framework.message.MessageStore

@Singleton
public class MessageStore
extends Object

Stores messages on behalf of MessagesManager in the repository, every user in the system has its own set of messages that have ids unique in combination with their userid. Ids are generated by taking the largest id in use and incrementing it by 1.

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	ASCENDING_KEYWORD
protected static String	DESCENDING_KEYWORD
protected static String	ORDER_BY

Constructor Summary

Constructors

Constructor and Description
MessageStore()

Method Summary

Modifier and Type	Method and Description
protected String	buildQueryMessageStatement(String userName, List<MessageType> messageTypeList, Map<String,Boolean> sortCriteria)
protected String	buildWhereTypesClause(MessageType[] messageTypes)
protected javax.jcr.query.QueryResult	executeQuery(String statement, String language, int limit, int offset)
List<Message>	findAllMessagesForUser(String userName)
Message	findMessageById(String userName, String messageId)
long	getMessageAmount(String userName, List<MessageType> types)
List<Message>	getMessages(String userName, List<MessageType> types, Map<String,Boolean> sortCriteria, int limit, int offset)
int	getNumberOfUnclearedMessagesForUser(String userName)
int	getNumberOfUnclearedMessagesForUserAndByType(String userName, MessageType type)
void	removeMessageById(String userName, String messageId)
boolean	saveMessage(String userName, Message message) Stores a new message or overwrites an existing one depending on whether there's an id set.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ORDER_BY

protected static final String ORDER_BY

See Also:

Constant Field Values

ASCENDING_KEYWORD

protected static final String ASCENDING_KEYWORD

See Also:

Constant Field Values

DESCENDING_KEYWORD

protected static final String DESCENDING_KEYWORD

See Also:

Constant Field Values

Constructor Detail

MessageStore

public MessageStore()

Method Detail

saveMessage

public boolean saveMessage(String userName,
                           Message message)

Stores a new message or overwrites an existing one depending on whether there's an id set. That is, the id of the message is respected if present otherwise a new unique one is used. When the method returns the message has been updated with a new id.

Parameters:

userName - user to save the message for

message - message to save

Returns:

true if saving was successful or false if it failed

getNumberOfUnclearedMessagesForUser

public int getNumberOfUnclearedMessagesForUser(String userName)

findAllMessagesForUser

public List<Message> findAllMessagesForUser(String userName)

getMessages

public List<Message> getMessages(String userName,
                                 List<MessageType> types,
                                 Map<String,Boolean> sortCriteria,
                                 int limit,
                                 int offset)

getMessageAmount

public long getMessageAmount(String userName,
                             List<MessageType> types)

buildQueryMessageStatement

protected String buildQueryMessageStatement(String userName,
                                            List<MessageType> messageTypeList,
                                            Map<String,Boolean> sortCriteria)

buildWhereTypesClause

protected String buildWhereTypesClause(MessageType[] messageTypes)

executeQuery

protected javax.jcr.query.QueryResult executeQuery(String statement,
                                                   String language,
                                                   int limit,
                                                   int offset)
                                            throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

findMessageById

public Message findMessageById(String userName,
                               String messageId)

removeMessageById

public void removeMessageById(String userName,
                              String messageId)

getNumberOfUnclearedMessagesForUserAndByType

public int getNumberOfUnclearedMessagesForUserAndByType(String userName,
                                                        MessageType type)