com.adobe.livecycle.rca
Interface MessageQueueService

public interface MessageQueueService

Method Summary

void	addMessageToUserQueue(String userId, MessageTO message) Add a new MessageTO to a user's queue.
MessageTO	deleteMessage(String messageId) Deletes a MessageTO from underlying persistence.
List	getUserQueue(String userId, String messageStatus) Get a User's message Queue.
MessageTO	setMessageStatus(String messageId, String status) Retrieve a MessageTO from underlying persistence.

Method Detail

addMessageToUserQueue

void addMessageToUserQueue(String userId,
                           MessageTO message)
                           throws ICRException

Add a new MessageTO to a user's queue.

Parameters:

userId - Unique ID of user

message - MessageTO instance to be added

Throws:

ICRException - Exception raised from underlying persistence store

getUserQueue

List getUserQueue(String userId,
                  String messageStatus)
                  throws ICRException

Get a User's message Queue.

Parameters:

userId - Unique ID of user

messageStatus - Filter messages by status. All messages are returned if null passed.

Returns:

List of MessageTO

Throws:

ICRException - Exception raised from underlying persistence store

setMessageStatus

MessageTO setMessageStatus(String messageId,
                           String status)
                           throws ICRException

Retrieve a MessageTO from underlying persistence.

Parameters:

messageId - Unique ID of message

status - Status of message

Returns:

Updated MessageTO

Throws:

ICRException - Exception raised from underlying persistence store

deleteMessage

MessageTO deleteMessage(String messageId)
                        throws ICRException

Deletes a MessageTO from underlying persistence.

Parameters:

messageId - Unique ID of message

Returns:

Deleted MessageTO

Throws:

ICRException - Exception raised from underlying persistence store