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

Class EmailTransitionProvider

java.lang.Object

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

All Implemented Interfaces:

Contexed, PathTransitionProvider<EditAction,MailTarget>, TransitionFactory<EditAction,MailTarget>, ViewPathTransitionProvider<EditAction,MailTarget>, ViewTransitionFactory<EditAction,MailTarget>

public class EmailTransitionProvider
extends java.lang.Object
implements ViewPathTransitionProvider<EditAction,MailTarget>

This is a transition based implementation of email editing. The main view page is implemented as a view transition or custom page with buttons/links going to direct transitions on the message. The hash value is included as an additional path element (ok if you think of it as a version number) The view transition shows an error message if the hash does not match The other transitions and actions forward to the view transition if the hash does not match To reduce the number of places this check is needed the hash is checked in getTransition(MailTarget, EditAction) and a generic Action is used for most operations. The edit_part view needs to use a CustomFormContent transition to insert the form into its correct place in the message view.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	EmailTransitionProvider.AbortTransition
class	EmailTransitionProvider.AddAttachmentTransition
class	EmailTransitionProvider.AddRecipientTransition
class	EmailTransitionProvider.AddReplyToTransition
class	EmailTransitionProvider.CreateTransition
static class	EmailTransitionProvider.DirectMailTransition
class	EmailTransitionProvider.DirectOperationTransition
class	EmailTransitionProvider.EditFormAction Generic action to apply an EditAction (parameterised by a single piece of additional data) to a location in a message.
class	EmailTransitionProvider.EditSubjectTransition
class	EmailTransitionProvider.EditTextTransition
class	EmailTransitionProvider.FormContentMailTransition
static class	EmailTransitionProvider.FormMailTransition
class	EmailTransitionProvider.SendTransition
class	EmailTransitionProvider.ServeTransition
class	EmailTransitionProvider.StartOverTransition
class	EmailTransitionProvider.TransitionLinker
class	EmailTransitionProvider.ViewDirectTransition

Field Summary

Fields

Modifier and Type	Field and Description
static Feature	SEND_NOW

Constructor Summary

Constructors

Constructor and Description
EmailTransitionProvider(MessageHandlerFactory fac)

Method Summary

Modifier and Type	Method and Description
<R> R	accept(TransitionFactoryVisitor<R,MailTarget,EditAction> vis) Accept a TransitionFactoryVisitor.
boolean	allowTransition(AppContext c, MailTarget target, EditAction key) Access control check.
boolean	canView(MailTarget target, SessionService<?> sess) Can the current person view this target
<X extends ContentBuilder> X	getBottomContent(X cb, MailTarget target, SessionService<?> sess) Get the content to be displayed at the bottom of the target page.
AppContext	getContext()
java.lang.String	getHelp(EditAction key) Get tooltip help string for an operation
java.util.LinkedList<java.lang.String>	getID(MailTarget target) Get the id string for form posts from a target
<X extends ContentBuilder> X	getLogContent(X cb, MailTarget target, SessionService<?> sess) Get the content to be displayed on the view target page as part of the target pane.
Logger	getLogger()
<X extends ContentBuilder> X	getSummaryContent(AppContext c, X cb, MailTarget target) Get target summary to be shown on transition page.
MailTarget	getTarget(java.util.LinkedList<java.lang.String> path) Find target type by id string
java.lang.String	getTargetName() What is the name for this type of transition.
java.lang.String	getText(EditAction key) get custom button content.
<X extends ContentBuilder> X	getTopContent(X cb, MailTarget target, SessionService<?> sess) Get the content to be displayed at the top of the target page.
Transition<MailTarget>	getTransition(MailTarget target, EditAction key) Find a transition operator for this type by key.
java.util.Set<EditAction>	getTransitions(MailTarget target) Get a list of all the transition keys supported by the target type to be presented to the user as a set of possible options in a view transition.
EditAction	lookupTransition(MailTarget target, java.lang.String name) Lookup a transition key by String This has to be the same as the result of the toString method on the key as this is what is passed from transitions.jsp for a form transition.

Methods inherited from class java.lang.Object

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

Methods inherited from interface uk.ac.ed.epcc.webapp.forms.transition.ViewTransitionFactory

showTransition

Field Detail

SEND_NOW

public static Feature SEND_NOW

Constructor Detail

EmailTransitionProvider

public EmailTransitionProvider(MessageHandlerFactory fac)

Method Detail

canView

public boolean canView(MailTarget target,
                       SessionService<?> sess)

Description copied from interface: ViewTransitionFactory

Can the current person view this target

Specified by:

canView in interface ViewTransitionFactory<EditAction,MailTarget>

Returns:

boolean

getTargetName

public java.lang.String getTargetName()

Description copied from interface: TransitionFactory

What is the name for this type of transition. This value needs to resolve to the TransitionProvider in the TransitionServlet The value can also be used as the user presented text for the type of object in the title of the transition form page though this can be overridden by setting target-name.transition_title

Specified by:

getTargetName in interface TransitionFactory<EditAction,MailTarget>

Returns:

String

getSummaryContent

public <X extends ContentBuilder> X getSummaryContent(AppContext c,
                                                      X cb,
                                                      MailTarget target)

Description copied from interface: TransitionFactory

Get target summary to be shown on transition page. In html this content is embedded within a div.block element.

Specified by:

getSummaryContent in interface TransitionFactory<EditAction,MailTarget>

Parameters:

c - AppContext

cb - ContentBuilder

Returns:

ContentBuilder

getTarget

public MailTarget getTarget(java.util.LinkedList<java.lang.String> path)

Description copied from interface: PathTransitionProvider

Find target type by id string

Specified by:

getTarget in interface PathTransitionProvider<EditAction,MailTarget>

Returns:

target or null

getID

public java.util.LinkedList<java.lang.String> getID(MailTarget target)

Description copied from interface: PathTransitionProvider

Get the id string for form posts from a target

Specified by:

getID in interface PathTransitionProvider<EditAction,MailTarget>

Returns:

id value

allowTransition

public boolean allowTransition(AppContext c,
                               MailTarget target,
                               EditAction key)

Description copied from interface: TransitionFactory

Access control check. Is this transition allowed for the current user/target

Specified by:

allowTransition in interface TransitionFactory<EditAction,MailTarget>

Parameters:

c - AppContext

target - target object

key - identifying key object for transition

Returns:

boolean is operation allowed

getTopContent

public <X extends ContentBuilder> X getTopContent(X cb,
                                                  MailTarget target,
                                                  SessionService<?> sess)

Description copied from interface: ViewTransitionFactory

Get the content to be displayed at the top of the target page. This content is at the top level of the page

Specified by:

getTopContent in interface ViewTransitionFactory<EditAction,MailTarget>

Returns:

boolean

getLogContent

public <X extends ContentBuilder> X getLogContent(X cb,
                                                  MailTarget target,
                                                  SessionService<?> sess)

Description copied from interface: ViewTransitionFactory

Get the content to be displayed on the view target page as part of the target pane.

Specified by:

getLogContent in interface ViewTransitionFactory<EditAction,MailTarget>

Returns:

ContentBuilder

getHelp

public java.lang.String getHelp(EditAction key)

Description copied from interface: ViewTransitionFactory

Get tooltip help string for an operation

Specified by:

getHelp in interface ViewTransitionFactory<EditAction,MailTarget>

Returns:

String or null

getText

public java.lang.String getText(EditAction key)

Description copied from interface: ViewTransitionFactory

get custom button content. should default to the string representation of the key

Specified by:

getText in interface ViewTransitionFactory<EditAction,MailTarget>

Returns:

String

getTransitions

public java.util.Set<EditAction> getTransitions(MailTarget target)

Description copied from interface: TransitionFactory

Get a list of all the transition keys supported by the target type to be presented to the user as a set of possible options in a view transition. Options in this list that are not allowed by TransitionFactory.allowTransition(AppContext, Object, Object) will not be presented. Additional hidden operations may also be supported but these will never be presented to the user as options and can only generated as a ChainedTransitionResult. In most cases the transition set will be the same for all null/non-null targets though in principal dynamic transitions could be generated based on the state of the target e.g. a parameterised transition with the parameter encoded in the key.

Specified by:

getTransitions in interface TransitionFactory<EditAction,MailTarget>

Returns:

Set of keys

getTransition

public Transition<MailTarget> getTransition(MailTarget target,
                                            EditAction key)

Description copied from interface: TransitionFactory

Find a transition operator for this type by key. This method is permitted to return null for example if the current user is not permitted to perform the transition.

Specified by:

getTransition in interface TransitionFactory<EditAction,MailTarget>

Parameters:

target - target (may be null)

key - key

Returns:

Transition or null

lookupTransition

public EditAction lookupTransition(MailTarget target,
                                   java.lang.String name)

Description copied from interface: TransitionFactory

Lookup a transition key by String This has to be the same as the result of the toString method on the key as this is what is passed from transitions.jsp for a form transition.

Specified by:

lookupTransition in interface TransitionFactory<EditAction,MailTarget>

Parameters:

target - (may be null)

Returns:

Transition key

getContext

public AppContext getContext()

Specified by:

getContext in interface Contexed

accept

public <R> R accept(TransitionFactoryVisitor<R,MailTarget,EditAction> vis)

Description copied from interface: TransitionFactory

Accept a TransitionFactoryVisitor. Any code that depends on the particular sub-interface of TransitionFactory should implement TransitionFactoryVisitor this ensures it will always handle all possible sub-classes.

Specified by:

accept in interface PathTransitionProvider<EditAction,MailTarget>

Specified by:

accept in interface TransitionFactory<EditAction,MailTarget>

Returns:

getLogger

public Logger getLogger()

getBottomContent

public <X extends ContentBuilder> X getBottomContent(X cb,
                                                     MailTarget target,
                                                     SessionService<?> sess)

Description copied from interface: ViewTransitionFactory

Get the content to be displayed at the bottom of the target page. This content is at the top level of the page

Specified by:

getBottomContent in interface ViewTransitionFactory<EditAction,MailTarget>

Returns:

boolean