uk.ac.ed.epcc.webapp.editors.mail

Interface MessageComposer

All Superinterfaces:

MessageHandler

All Known Subinterfaces:

MessageComposerExtraFormat

All Known Implementing Classes:

AbstractMessageHandlerFactory.Composer

public interface MessageComposer
extends MessageHandler

Interface for classes that represent a message undergoing composition

Method Summary

Modifier and Type	Method and Description
FormResult	abort() Abort the composition of the message
boolean	allowNewAttachments()
boolean	bccOnly()
boolean	canEdit(java.util.List<java.lang.String> path, SessionService<?> operator) Is the specified person allowed to edit this message
boolean	editRecipients()
default boolean	editReplyTo()
Input<java.lang.String>	getEmailInput() get an Input for email addresses.
void	populate(SessionService<?> operator) Initialise the message to a starting state if it has not already been set.
void	repopulate(SessionService<?> operator) re-initialise the message to its starting state
FormResult	send(SessionService<?> operator) Send the message
boolean	showBcc()

Methods inherited from interface uk.ac.ed.epcc.webapp.editors.mail.MessageHandler

canView, getFactory, getMessageProvider, getPath, getTypeName

Method Detail

send

FormResult send(SessionService<?> operator)
         throws java.lang.Exception

Send the message

Parameters:

operator -

Returns:

FormResult to invoke after send

Throws:

java.lang.Exception

repopulate

void repopulate(SessionService<?> operator)
         throws java.lang.Exception

re-initialise the message to its starting state

Parameters:

operator -

Throws:

java.lang.Exception

populate

void populate(SessionService<?> operator)
       throws java.lang.Exception

Initialise the message to a starting state if it has not already been set. If a message already exists do nothing.

Parameters:

operator -

Throws:

java.lang.Exception

abort

FormResult abort()
          throws DataFault

Abort the composition of the message

Returns:

FormResult to use after abort.

Throws:

DataFault

canEdit

boolean canEdit(java.util.List<java.lang.String> path,
                SessionService<?> operator)

Is the specified person allowed to edit this message

Parameters:

path - being edited

operator -

Returns:

boolean

getEmailInput

Input<java.lang.String> getEmailInput()

get an Input for email addresses. Only used if the composer allows. Normally this will just be and EmailInput but a MessageComposer can substitute something else to make it easier to find the desired email. The action will accept a comma separated list of multiple values if the composer wishes to support bulk add

Returns:

Input

editRecipients

boolean editRecipients()

showBcc

boolean showBcc()

bccOnly

boolean bccOnly()

allowNewAttachments

boolean allowNewAttachments()

editReplyTo

default boolean editReplyTo()