uk.ac.ed.epcc.webapp.model.period

Class SplitTransition.SplitAction

java.lang.Object

uk.ac.ed.epcc.webapp.forms.action.FormAction

uk.ac.ed.epcc.webapp.model.period.SplitTransition.SplitAction

Enclosing class:

SplitTransition<T extends TimePeriod,K>

public class SplitTransition.SplitAction
extends FormAction

Constructor Summary

Constructors

Constructor and Description
SplitAction(T target, boolean nav_first)

Method Summary

Modifier and Type	Method and Description
ViewTransitionResult<T,K>	action(Form f) Perform the actual action based on the form parameters.
java.lang.String	getConfirm(Form f) should this action be confirmed before execute If this returns null no confirm is required.
java.lang.String	getHelp() Return an optional help text for this action that can be presented as a tooltip etc.

Methods inherited from class uk.ac.ed.epcc.webapp.forms.action.FormAction

getConfirmMessage, getMustValidate, getShortcut, getText, setConfirm, setConfirmArgs, setMustValidate, setNewWindow, wantNewWindow

Methods inherited from class java.lang.Object

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

Constructor Detail

SplitAction

public SplitAction(T target,
                   boolean nav_first)

Method Detail

getHelp

public java.lang.String getHelp()

Description copied from class: FormAction

Return an optional help text for this action that can be presented as a tooltip etc.

Overrides:

getHelp in class FormAction

Returns:

String or null

action

public ViewTransitionResult<T,K> action(Form f)
                                 throws ActionException

Description copied from class: FormAction

Perform the actual action based on the form parameters. Throw a TransitionException to show an error message to the user. or a ActionException to produce a generic error message.

Specified by:

action in class FormAction

Parameters:

f - Form

Returns:

FormResult

Throws:

ActionException

getConfirm

public java.lang.String getConfirm(Form f)

Description copied from class: FormAction

should this action be confirmed before execute If this returns null no confirm is required. If not null it is the name of the confirm message in the confirm.properties

The form is passed to allow a sub-class to trigger confirm based on form parameters. However in this case the implementation must handle an incomplete form. Note that the message can be set by calling FormAction.setConfirm(String) or this method can be overidden

Overrides:

getConfirm in class FormAction

Parameters:

f - Form calling action.

Returns:

String confirm name