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

Class StateRelationshipComposite<U extends AppUser,BDO extends DataObject,X extends StateRelationshipComposite>

java.lang.Object

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

uk.ac.ed.epcc.webapp.model.data.StateRelationshipComposite<U,BDO,X>

All Implemented Interfaces:

Contexed, TableStructureContributer<BDO>, AccessRoleProvider<U,BDO>

public class StateRelationshipComposite<U extends AppUser,BDO extends DataObject,X extends StateRelationshipComposite>
extends Composite<BDO,X>
implements AccessRoleProvider<U,BDO>

A Composite that adds boolean field to an object. The value of this field determines if SessionServices have a corresponding relationship with the target. This is used in AND combination with other relationships to allow the other relationship to be activated on a per-target basis. The class can be sub-classed to include multiple instances for different fields as it registers under its actual class.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	StateRelationshipComposite.Filter
class	StateRelationshipComposite.PersonFilter<U extends AppUser>

Field Summary

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

fac

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	addRelationships(java.util.Set<java.lang.String> roles) Add known roles to a set.
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.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.
protected boolean	getDefault()
protected java.lang.Class<? super X>	getType() Returns the type the composite should be registered under.
BaseFilter<BDO>	hasRelationFilter(java.lang.String role, U u) Get a BaseFilter corresponding to target objects where the given user has the specified relation.
TableSpecification	modifyDefaultTableSpecification(TableSpecification spec, java.lang.String table) Modify the TableSpecification of the target factory.
BaseFilter<U>	personInRelationFilter(SessionService<U> sess, java.lang.String role, BDO target) Get a BaseFilter for AppUsers that are in the specified relationship with the target object.
boolean	providesRelationship(java.lang.String role) Does this class provide the named relationship.

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

addDefaults, addFieldHelp, addOptional, addSuppress, 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

Constructor Detail

StateRelationshipComposite

protected StateRelationshipComposite(DataObjectFactory<BDO> fac,
                                     java.lang.String field)

Parameters:

fac -

Method Detail

getType

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

Description copied from class: Composite

Returns the type the composite should be registered under.

Specified by:

getType in class Composite<BDO extends DataObject,X extends StateRelationshipComposite>

Returns:

registration type

hasRelationFilter

public BaseFilter<BDO> hasRelationFilter(java.lang.String role,
                                         U u)

Description copied from interface: AccessRoleProvider

Get a BaseFilter corresponding to target objects where the given user has the specified relation. If the method returns null then the role is not recognised by the provider. A non-null result means the role is recognised but does not imply that any target will match. The relation with a specific target object can be tested using DataObjectFactory.matches(BaseFilter, DataObject) This method should not be called directly only via a call to SessionService.getRelationshipRoleFilter(DataObjectFactory, String) to allow the SessionService to combine and customise access rules.

Specified by:

hasRelationFilter in interface AccessRoleProvider<U extends AppUser,BDO extends DataObject>

Returns:

BaseFilter or null

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<BDO extends DataObject>

Overrides:

modifyDefaultTableSpecification in class Composite<BDO extends DataObject,X extends StateRelationshipComposite>

Returns:

getDefault

protected boolean getDefault()

Returns:

addTranslations

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

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<BDO extends DataObject>

Overrides:

addTranslations in class Composite<BDO extends DataObject,X extends StateRelationshipComposite>

Returns:

Map

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<BDO extends DataObject>

Overrides:

addSelectors in class Composite<BDO extends DataObject,X extends StateRelationshipComposite>

Returns:

Map of modified selectors/inputs

personInRelationFilter

public BaseFilter<U> personInRelationFilter(SessionService<U> sess,
                                            java.lang.String role,
                                            BDO target)

Description copied from interface: AccessRoleProvider

Get a BaseFilter for AppUsers that are in the specified relationship with the target object. This is the inverse of #hasRelationFilter(SessionService, String) used to generate a list of AppUser with the relation. It can always be implemented (inefficiently) by creating an AcceptFilter that uses AccessRoleProvider.hasRelationFilter(String, AppUser) to check each person in turn but though it is usually possible to find some SQLFilter to narrow the selection first even if a full SQL implementation is not possible. If the target is null it should generate a filter for any user in relation with targets selected by DataObjectFactory.getDefaultRelationshipFilter(). If this is not possible it should return null;

Specified by:

personInRelationFilter in interface AccessRoleProvider<U extends AppUser,BDO extends DataObject>

Returns:

BaseFilter or null

providesRelationship

public boolean providesRelationship(java.lang.String role)

Description copied from interface: AccessRoleProvider

Does this class provide the named relationship.

Specified by:

providesRelationship in interface AccessRoleProvider<U extends AppUser,BDO extends DataObject>

Returns:

true if relationship provided by this class.

addRelationships

public void addRelationships(java.util.Set<java.lang.String> roles)

Description copied from interface: AccessRoleProvider

Add known roles to a set. This can be roles provided or consumed by the class. This is only used as auto-complete suggestions so should be a useful subset rather than an exhaustive list

Specified by:

addRelationships in interface AccessRoleProvider<U extends AppUser,BDO extends DataObject>