uk.ac.ed.epcc.webapp.model.data

Class CreateAction<BDO extends DataObject>

java.lang.Object

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

uk.ac.ed.epcc.webapp.model.data.CreateAction<BDO>

Type Parameters:

BDO - type we are creating

public final class CreateAction<BDO extends DataObject>
extends FormAction

FormAction class to create the target DataObject from a form This class needs access to package level methods from DataObjectFactory.

Constructor Summary

Constructors

Constructor and Description
CreateAction(java.lang.String type_name, CreateTemplate<BDO> dataObjectFactory)
CreateAction(java.lang.String type_name, java.lang.Object text, CreateTemplate<BDO> dataObjectFactory)

Method Summary

Modifier and Type	Method and Description
FormResult	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.Object	getText() Get optional button content to use instead of the action name.
void	postCreate(BDO dat, Form f)
void	preCommit(BDO dat, Form f)

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

getConfirmMessage, getHelp, getMustValidate, getShortcut, 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

CreateAction

public CreateAction(java.lang.String type_name,
                    CreateTemplate<BDO> dataObjectFactory)

Parameters:

type_name - User presetned name of type being created.

dataObjectFactory -

CreateAction

public CreateAction(java.lang.String type_name,
                    java.lang.Object text,
                    CreateTemplate<BDO> dataObjectFactory)

Method Detail

action

public FormResult 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

preCommit

public final void preCommit(BDO dat,
                            Form f)
                     throws DataException,
                            ActionException

Throws:

DataException

ActionException

postCreate

public void postCreate(BDO dat,
                       Form f)
                throws java.lang.Exception

Throws:

java.lang.Exception

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

getText

public java.lang.Object getText()

Description copied from class: FormAction

Get optional button content to use instead of the action name. This can be a UIProvider or UIGenerator but should not include active content

Overrides:

getText in class FormAction

Returns:

Object to add