uk.ac.ed.epcc.webapp.session

Class GlobalNamePolicy<AU extends AppUser,X extends GlobalNamePolicy>

java.lang.Object

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

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

uk.ac.ed.epcc.webapp.session.AppUserNameFinder<AU,F>

uk.ac.ed.epcc.webapp.session.FieldNameFinder<AU,X>

uk.ac.ed.epcc.webapp.session.GlobalNamePolicy<AU,X>

All Implemented Interfaces:

TemplateContributor<AU>, Contexed, AnonymisingComposite<AU>, TableStructureContributer<AU>, HistoryFieldContributor, ParseFactory<AU>, AppUserCommitObserver<AU>

Direct Known Subclasses:

UUIDNamePolicy

public abstract class GlobalNamePolicy<AU extends AppUser,X extends GlobalNamePolicy>
extends FieldNameFinder<AU,X>
implements AppUserCommitObserver<AU>, AnonymisingComposite<AU>, TemplateContributor<AU>

Policy object to add an auto-generated global name to an AppUser.

Field Summary

Fields inherited from class uk.ac.ed.epcc.webapp.session.FieldNameFinder

PROPERTY_PREFIX

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

fac

Constructor Summary

Constructors

Constructor and Description
GlobalNamePolicy(AppUserFactory<AU> factory, java.lang.String realm)

Method Summary

Modifier and Type	Method and Description
void	anonymise(AU target)
abstract java.lang.String	getName(AU p) Generate a unique global name for the uncommitted person.
void	post_commit(AU person, boolean changed) AppUser has been edited
void	pre_commit(AU person, boolean dirty) AppUser has been edited and is about to be comitted
void	setTemplateContent(TemplateFile template, java.lang.String prefix, AU target) Set parameters in a template.
protected boolean	userSet()

Methods inherited from class uk.ac.ed.epcc.webapp.session.FieldNameFinder

active, addSuppress, addToHistorySpecification, addTranslations, customiseForm, customiseUpdateForm, defaultFieldLength, getCanonicalName, getNameLabel, getStringFinderFilter, modifyDefaultTableSpecification, normalizeName, setName, userVisible

Methods inherited from class uk.ac.ed.epcc.webapp.session.AppUserNameFinder

findFromString, getAllNames, getDataCache, getRealm, getType, toString, validateName, verified

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

addDefaults, addFieldHelp, addOptional, addSelectors, getContext, getFactory, getLogger, getRecord, getRepository, postUpdate, preRegister, release

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.AnonymisingComposite

addEraseFields

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

addFieldConstraints, addFormFields

Constructor Detail

GlobalNamePolicy

public GlobalNamePolicy(AppUserFactory<AU> factory,
                        java.lang.String realm)

Method Detail

getName

public abstract java.lang.String getName(AU p)

Generate a unique global name for the uncommitted person.

Parameters:

p - uncommitted person.

Returns:

pre_commit

public void pre_commit(AU person,
                       boolean dirty)
                throws DataFault

Description copied from interface: AppUserCommitObserver

AppUser has been edited and is about to be comitted

Specified by:

pre_commit in interface AppUserCommitObserver<AU extends AppUser>

Parameters:

person - AppUser being changed

dirty - boolean record is known to contain changes

Throws:

DataFault

post_commit

public void post_commit(AU person,
                        boolean changed)
                 throws DataFault

Description copied from interface: AppUserCommitObserver

AppUser has been edited

Specified by:

post_commit in interface AppUserCommitObserver<AU extends AppUser>

Parameters:

person - AppUser that was edited

changed - boolean contents have changed

Throws:

DataFault

userSet

protected final boolean userSet()

Overrides:

userSet in class FieldNameFinder<AU extends AppUser,X extends GlobalNamePolicy>

anonymise

public void anonymise(AU target)

Specified by:

anonymise in interface AnonymisingComposite<AU extends AppUser>

setTemplateContent

public void setTemplateContent(TemplateFile template,
                               java.lang.String prefix,
                               AU target)

Description copied from interface: TemplateContributor

Set parameters in a template. The prefix is to allow multiple objects of the same type to be added to a template under differnet names.

Specified by:

setTemplateContent in interface TemplateContributor<AU extends AppUser>

Parameters:

template - TemplateFile to add content to.

prefix - String prefix to be pre-pended to property/region names

target - Object to take data from