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

Class CreateTransition<BDO extends DataObject>

java.lang.Object

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

uk.ac.ed.epcc.webapp.model.data.forms.CreateTransition<BDO>

Type Parameters:

BDO -

All Implemented Interfaces:

FormFactory, TargetLessTransition<BDO>, Transition<BDO>, TypeConverter<BDO,java.lang.Number>, CreateCustomizer<BDO>, CreateTemplate<BDO>, IndexedProducer<BDO>, Targetted<BDO>

Direct Known Subclasses:

DynamicFormTransitionProvider.Creator

public abstract class CreateTransition<BDO extends DataObject>
extends DataObjectFormFactory<BDO>
implements TargetLessTransition<BDO>, CreateTemplate<BDO>

A TargetLessTransition for creating DataObjects. This class extends DataObjectFromFactory directly rather than wrapping a Creator object making it easier to customise.

See Also:

Creator

Field Summary

Fields inherited from class uk.ac.ed.epcc.webapp.model.data.DataObjectFormFactory

DEFAULT_FORBID_HTML, factory

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CreateTransition(java.lang.String name, DataObjectFactory<BDO> fac)

Method Summary

Modifier and Type	Method and Description
void	buildForm(Form f, AppContext c) Build the transition form.
void	customiseCreationForm(Form f) Perform target specific customisation of a creation Form.
java.lang.Object	getActionText() Override the text for the create button
java.lang.String	getConfirm(Form f) should a confirm dialog be presented.
FormResult	getResult(TransitionVisitor<BDO> vis)
void	postCreate(BDO dat, Form f) Take any action after object commit.
void	preCommit(BDO dat, Form f) Populate target from creation form.

Methods inherited from class uk.ac.ed.epcc.webapp.model.data.DataObjectFormFactory

addOptionalFromComposites, addSelectors, addTranslations, buildForm, buildForm, buildForm, buildForm, buildForm, customiseForm, find, find, getContext, getDefaults, getFactory, getFieldConstraints, getFieldHelp, getFields, getID, getIndex, getInputFromName, getInputFromType, getLogger, getOptional, getSelectors, getSupress, getTarget, getTranslations, isMyReference, makeReference, makeReference

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.model.data.forms.CreateTemplate

getDefaults, getFactory, getResult

Constructor Detail

CreateTransition

protected CreateTransition(java.lang.String name,
                           DataObjectFactory<BDO> fac)

Method Detail

buildForm

public void buildForm(Form f,
                      AppContext c)
               throws TransitionException

Description copied from interface: TargetLessTransition

Build the transition form. The actions of this form should return a TransitionResult

Specified by:

buildForm in interface TargetLessTransition<BDO extends DataObject>

Parameters:

f - Form to be built

c - AppContext

Throws:

TransitionException

getActionText

public java.lang.Object getActionText()

Override the text for the create button

Returns:

object added as button content

getResult

public FormResult getResult(TransitionVisitor<BDO> vis)
                     throws TransitionException

Specified by:

getResult in interface TargetLessTransition<BDO extends DataObject>

Specified by:

getResult in interface Transition<BDO extends DataObject>

Throws:

TransitionException

postCreate

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

Description copied from interface: CreateCustomizer

Take any action after object commit.

Specified by:

postCreate in interface CreateCustomizer<BDO extends DataObject>

Throws:

java.lang.Exception

preCommit

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

Description copied from interface: CreateCustomizer

Populate target from creation form. This can be sub-classes to add additional information such as the requesting Person or other information derived other than from the form parameters. Normally the form contents have already been set in the Object but the form is passed to this method in case any form parameters are used to control the way the object is created.

Specified by:

preCommit in interface CreateCustomizer<BDO extends DataObject>

Parameters:

dat - Object being created

f - Form providing parameters

Throws:

DataException

ActionException

getConfirm

public java.lang.String getConfirm(Form f)

Description copied from interface: CreateTemplate

should a confirm dialog be presented. A null value means no confirm dialog.

Specified by:

getConfirm in interface CreateTemplate<BDO extends DataObject>

Returns:

confirm type or null

customiseCreationForm

public void customiseCreationForm(Form f)
                           throws java.lang.Exception

Perform target specific customisation of a creation Form. For example adding a special validator. Note that this is called in addition to the basic customiseForm call

Specified by:

customiseCreationForm in interface CreateCustomizer<BDO extends DataObject>

Parameters:

f - Form to be modified

Throws:

java.lang.Exception