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

Interface TableStructureContributer<BDO extends DataObject>

Type Parameters:

BDO -

All Known Implementing Classes:

AppUserComposite, AppUserNameFinder, AvatarComposite, CertificateComposite, CodeAuthComposite, Composite, ConfigNamedFilterComposite, CreateComposite, CrossCookieComposite, DatabasePasswordComposite, DirectoryComposite, EmailNameFinder, FieldNameFinder, FixedCodeAuthComposite, FormAuthComposite, GlobalNamePolicy, LdapPasswordComposite, MultiComposite, MultiKeyComposite, MultiNameFinder, OldSingleKeyComposite, PasswordAuthComposite, PreferredViewComposite, PublicKeyComposite, RealNameComposite, ReferenceServiceFilterComposite, RegistrationDateComposite, SecondaryNameFinder, ServiceFilterComposite, ShibAttributeListener, SignupDateComposite, SingleKeyComposite, StateRelationshipComposite, TertiaryNameFinder, TotpCodeAuthComposite, UUIDNamePolicy, WebNameFinder

public interface TableStructureContributer<BDO extends DataObject>

An interface for objects that contribute fields etc. to the structure of a table and control the default form generation of those fields.

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.Object>	addDefaults(java.util.Map<java.lang.String,java.lang.Object> defaults) Generate a set of default property values.
default java.util.Map<java.lang.String,FieldConstraint>	addFieldConstraints(java.util.Map<java.lang.String,FieldConstraint> constraints) Add any FieldConstraint for the form.
java.util.Map<java.lang.String,java.lang.String>	addFieldHelp(java.util.Map<java.lang.String,java.lang.String> help) return a default set of tooltip help text for form fields.
default java.util.Set<java.lang.String>	addFormFields(java.util.Set<java.lang.String> fields) Add additional field named to be considered when building the form.
java.util.Set<java.lang.String>	addOptional(java.util.Set<java.lang.String> optional) generate the set of optional fields to be used to provide class specific defaults in form creation/update.
java.util.Map<java.lang.String,Selector>	addSelectors(java.util.Map<java.lang.String,Selector> selectors) Get a Map of selectors to use for forms of this type.
java.util.Set<java.lang.String>	addSuppress(java.util.Set<java.lang.String> suppress) generate the class specific set of suppressed fields to be used in form creation/update The individual forms can override these so you usually use this method to define fields that should be suppressed in all forms.
java.util.Map<java.lang.String,java.lang.String>	addTranslations(java.util.Map<java.lang.String,java.lang.String> translations) return a default set of translation between field names and text labels.
void	customiseForm(Form f) Extension hook to allow additional Form customisation generic to all types of Form (create and update) For example adding a FormValidator .
void	customiseUpdateForm(Form f, BDO target, SessionService operator) Extension hook to allow additional Form customisation specific to the update of an existing object.
TableSpecification	modifyDefaultTableSpecification(TableSpecification spec, java.lang.String table) Modify the TableSpecification of the target factory.
void	postUpdate(BDO o, Form f, java.util.Map<java.lang.String,java.lang.Object> orig, boolean changed) perform side effects after a formupdate

Method Detail

modifyDefaultTableSpecification

TableSpecification modifyDefaultTableSpecification(TableSpecification spec,
                                                   java.lang.String table)

Modify the TableSpecification of the target factory.

Parameters:

spec -

table -

Returns:

addOptional

java.util.Set<java.lang.String> addOptional(java.util.Set<java.lang.String> optional)

generate the set of optional fields to be used to provide class specific defaults in form creation/update. If null is returned the default behaviour is to take fields that can be null in the database.

Parameters:

optional -

Returns:

Set

addDefaults

java.util.Map<java.lang.String,java.lang.Object> addDefaults(java.util.Map<java.lang.String,java.lang.Object> defaults)

Generate a set of default property values. override this in sub-classes to give defaults when creating objects.

Parameters:

defaults -

Returns:

Map of default values

addTranslations

java.util.Map<java.lang.String,java.lang.String> addTranslations(java.util.Map<java.lang.String,java.lang.String> translations)

return a default set of translation between field names and text labels. This method provides a class specific set of defaults. The individual Form classes can still override this.

Parameters:

translations -

Returns:

Map

addFieldHelp

java.util.Map<java.lang.String,java.lang.String> addFieldHelp(java.util.Map<java.lang.String,java.lang.String> help)

return a default set of tooltip help text for form fields. This method provides a class specific set of defaults. The individual Form classes can still override this.

Parameters:

help -

Returns:

Map

addSelectors

java.util.Map<java.lang.String,Selector> addSelectors(java.util.Map<java.lang.String,Selector> selectors)

Get a Map of selectors to use for forms of this type. This method provides a class specific set of defaults but the specific form classes can override this.

Parameters:

selectors -

Returns:

Map of modified selectors/inputs

addSuppress

java.util.Set<java.lang.String> addSuppress(java.util.Set<java.lang.String> suppress)

generate the class specific set of suppressed fields to be used in form creation/update The individual forms can override these so you usually use this method to define fields that should be suppressed in all forms.

Parameters:

supress -

Returns:

Set of fields to suppress in forms.

addFormFields

default java.util.Set<java.lang.String> addFormFields(java.util.Set<java.lang.String> fields)

Add additional field named to be considered when building the form. This could be added in the customise methods but this will work better with multi-stage forms

Parameters:

fields -

Returns:

addFieldConstraints

default java.util.Map<java.lang.String,FieldConstraint> addFieldConstraints(java.util.Map<java.lang.String,FieldConstraint> constraints)

Add any FieldConstraint for the form. Note there may be multiple constraints for a field so existing values should be merged using FieldConstraint.add(FieldConstraint, FieldConstraint)

Parameters:

constraints -

Returns:

modifed map

customiseForm

void customiseForm(Form f)

Extension hook to allow additional Form customisation generic to all types of Form (create and update) For example adding a FormValidator . Logic that requires an existing object can be added to customiseUpdateForm(Form, DataObject, SessionService)

Parameters:

f - Form to modify

customiseUpdateForm

void customiseUpdateForm(Form f,
                         BDO target,
                         SessionService operator)

Extension hook to allow additional Form customisation specific to the update of an existing object. This can also add constraints based on the relationship of the operator to the object being updated. Logic that does not require an existing object can be added to customiseForm(Form)

Parameters:

f -

target -

operator -

postUpdate

void postUpdate(BDO o,
                Form f,
                java.util.Map<java.lang.String,java.lang.Object> orig,
                boolean changed)
         throws DataException

perform side effects after a formupdate

Parameters:

o -

f -

orig -

Throws:

DataException