uk.ac.ed.epcc.webapp.session

Class PreferredViewComposite<AU extends AppUser>

java.lang.Object

uk.ac.ed.epcc.webapp.model.data.Composite<AU,X>

uk.ac.ed.epcc.webapp.session.AppUserComposite<AU,PreferredViewComposite>

uk.ac.ed.epcc.webapp.session.PreferredViewComposite<AU>

Type Parameters:

AU - type of AppUser

All Implemented Interfaces:

Contexed, TableStructureContributer<AU>, EmailParamContributor<AU>, NewSignupAction<AU>

public class PreferredViewComposite<AU extends AppUser>
extends AppUserComposite<AU,PreferredViewComposite>
implements NewSignupAction<AU>, EmailParamContributor<AU>

An AppUserComposite that returns an optional preferred view for AppUsers. This is when there are multiple flavours of an applications sharing a database but we want to tie certain users to a certain view. This is used to customise template email messages to the user. If set the parameter prefered_view.default defines the view URL (equivalent to service.saf.url that should be set for users created/signing-up). This should normally only be set within the view in question.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PREFERRED_VIEW

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

fac

Constructor Summary

Constructors

Constructor and Description
PreferredViewComposite(AppUserFactory<AU> fac)

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.
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.
void	addParams(java.util.Map<java.lang.String,java.lang.String> params, AU user)
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> labels) return a default set of translation between field names and text labels.
PreferedView	getDefaultView()
PreferedView	getPreferredView(AU person)
protected java.lang.Class<? super PreferredViewComposite>	getType() Returns the type the composite should be registered under.
PreferedViewFactory	getViewFactory()
TableSpecification	modifyDefaultTableSpecification(TableSpecification spec, java.lang.String table) Modify the TableSpecification of the target factory.
void	newSignup(AU user)
void	setPreferredView(AU person, PreferedView c)
void	setRegions(TemplateFile template, AU user)

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

addFieldHelp, customiseForm, customiseUpdateForm, getContext, getFactory, getLogger, getRecord, getRepository, postUpdate, preRegister, release, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface uk.ac.ed.epcc.webapp.model.data.TableStructureContributer

addFieldConstraints, addFormFields

Field Detail

PREFERRED_VIEW

public static final java.lang.String PREFERRED_VIEW

See Also:

Constant Field Values

Constructor Detail

PreferredViewComposite

public PreferredViewComposite(AppUserFactory<AU> fac)

Method Detail

getViewFactory

public PreferedViewFactory getViewFactory()

getType

protected java.lang.Class<? super PreferredViewComposite> getType()

Description copied from class: Composite

Returns the type the composite should be registered under.

Specified by:

getType in class Composite<AU extends AppUser,PreferredViewComposite>

Returns:

registration type

modifyDefaultTableSpecification

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

Description copied from interface: TableStructureContributer

Modify the TableSpecification of the target factory.

Specified by:

modifyDefaultTableSpecification in interface TableStructureContributer<AU extends AppUser>

Overrides:

modifyDefaultTableSpecification in class Composite<AU extends AppUser,PreferredViewComposite>

Returns:

addTranslations

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

Description copied from interface: TableStructureContributer

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.

Specified by:

addTranslations in interface TableStructureContributer<AU extends AppUser>

Overrides:

addTranslations in class Composite<AU extends AppUser,PreferredViewComposite>

Returns:

Map

addOptional

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

Description copied from interface: TableStructureContributer

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.

Specified by:

addOptional in interface TableStructureContributer<AU extends AppUser>

Overrides:

addOptional in class Composite<AU extends AppUser,PreferredViewComposite>

Returns:

Set

addSuppress

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

Description copied from interface: TableStructureContributer

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.

Specified by:

addSuppress in interface TableStructureContributer<AU extends AppUser>

Overrides:

addSuppress in class Composite<AU extends AppUser,PreferredViewComposite>

Returns:

Set of fields to suppress in forms.

addSelectors

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

Description copied from interface: TableStructureContributer

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.

Specified by:

addSelectors in interface TableStructureContributer<AU extends AppUser>

Overrides:

addSelectors in class Composite<AU extends AppUser,PreferredViewComposite>

Returns:

Map of modified selectors/inputs

getPreferredView

public PreferedView getPreferredView(AU person)

setPreferredView

public void setPreferredView(AU person,
                             PreferedView c)

addDefaults

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

Description copied from interface: TableStructureContributer

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

Specified by:

addDefaults in interface TableStructureContributer<AU extends AppUser>

Overrides:

addDefaults in class Composite<AU extends AppUser,PreferredViewComposite>

Returns:

Map of default values

getDefaultView

public PreferedView getDefaultView()

Returns:

newSignup

public void newSignup(AU user)
               throws java.lang.Exception

Specified by:

newSignup in interface NewSignupAction<AU extends AppUser>

Throws:

java.lang.Exception

addParams

public void addParams(java.util.Map<java.lang.String,java.lang.String> params,
                      AU user)

Specified by:

addParams in interface EmailParamContributor<AU extends AppUser>

setRegions

public void setRegions(TemplateFile template,
                       AU user)

Specified by:

setRegions in interface EmailParamContributor<AU extends AppUser>