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

Interface MessageHandler

All Known Subinterfaces:

MessageComposer, MessageComposerExtraFormat

All Known Implementing Classes:

AbstractMessageHandlerFactory.Composer, AbstractMessageHandlerFactory.Handler

public interface MessageHandler

An object that represents a message.

See Also:

MessageHandlerFactory, MessageComposer, MessageCreator

Method Summary

Modifier and Type	Method and Description
boolean	canView(java.util.List<java.lang.String> path, SessionService<?> operator) Is the specified person allowed to view this message
MessageHandlerFactory	getFactory(AppContext conn) Get the MessageHandlerFactory for this MessageHandler.
MessageProvider	getMessageProvider() get the MessageProvider corresponding to the Message
java.util.List<java.lang.String>	getPath() Get the path to generate the MessageHandler from the MessageHandlerFactory
java.lang.String	getTypeName() get identifying name for the type of message being edited

Method Detail

getMessageProvider

MessageProvider getMessageProvider()
                            throws java.lang.Exception

get the MessageProvider corresponding to the Message

Returns:

MessageProvider

Throws:

java.lang.Exception

canView

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

Is the specified person allowed to view this message

Parameters:

path - Path being viewed

operator -

Returns:

boolean

getTypeName

java.lang.String getTypeName()

get identifying name for the type of message being edited

Returns:

String

getFactory

MessageHandlerFactory getFactory(AppContext conn)

Get the MessageHandlerFactory for this MessageHandler.

Parameters:

conn -

Returns:

MessageHandlerFactory

getPath

java.util.List<java.lang.String> getPath()

Get the path to generate the MessageHandler from the MessageHandlerFactory

Returns: