curam.participantmessages.impl

Interface ParticipantMessages

@AccessLevel(value=EXTERNAL)
public interface ParticipantMessages

This interface is passed as an argument to an event in order to gather messages regarding a given participant. The messages are added by a series of listeners.

Since:

6.0

Method Summary

Modifier and Type	Method and Description
void	addMessage(ParticipantMessage participantMessage) Adds a ParticipantMessage message to the list of messages.
void	addMessages(java.util.List<ParticipantMessage> participantMessageList) Adds a list of messages to the existing list of messages.
ConcernRole	getConcernRole() Returns the ConcernRole that messages are being gathered for.
java.util.ArrayList<ParticipantMessage>	getMessages() Returns the list of messages as an ArrayList.

Method Detail

addMessage

void addMessage(ParticipantMessage participantMessage)

Adds a ParticipantMessage message to the list of messages.

Parameters:

participantMessage - The message to be added to the list.

addMessages

void addMessages(java.util.List<ParticipantMessage> participantMessageList)

Adds a list of messages to the existing list of messages.

Parameters:

participantMessageList - The list of messages to be added to the list.

getConcernRole

ConcernRole getConcernRole()

Returns the ConcernRole that messages are being gathered for. Used by listeners to determine if there are any messages relevant to this concern role.

Returns:

concernRole the concern role that messages are being gathered for.

getMessages

java.util.ArrayList<ParticipantMessage> getMessages()

Returns the list of messages as an ArrayList.

Returns:

The list of messages as an ArrayList.