uk.ac.ed.epcc.webapp.model.relationship

Interface AccessRoleProvider<U extends AppUser,T extends DataObject>

Type Parameters:

U - AppUser type

T - Target type

All Known Subinterfaces:

RelationshipProvider<A,B>

All Known Implementing Classes:

AbstractRelationship, AppUserFactory, PersonRelationship, Relationship, RelationshipLinkManager, RemoteAccessRoleProvider, StateRelationshipComposite

public interface AccessRoleProvider<U extends AppUser,T extends DataObject>

Interface for classes that provide relationship roles between an AppUser and a target object. If the relationship only depends on the target object not on the AppUser then use NamedFilterProvider. DataObjectFactorys and Composites should implement this interface for roles provided by AppUser references. In this case it is a good idea to return a DualFilter to allow tests without accessing the database. It can also be implemented by stand-alone plug-ins.

See Also:

RelationshipProvider, NamedFilterProvider, SessionService

Method Summary

Modifier and Type	Method and Description
void	addRelationships(java.util.Set<java.lang.String> roles) Add known roles to a set.
BaseFilter<T>	hasRelationFilter(java.lang.String role, U user) Get a BaseFilter corresponding to target objects where the given user has the specified relation.
BaseFilter<U>	personInRelationFilter(SessionService<U> sess, java.lang.String role, T 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.

Method Detail

hasRelationFilter

BaseFilter<T> hasRelationFilter(java.lang.String role,
                                U user)

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.

Parameters:

role -

user -

Returns:

BaseFilter or null

personInRelationFilter

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

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 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;

Returns:

BaseFilter or null

providesRelationship

boolean providesRelationship(java.lang.String role)

Does this class provide the named relationship.

Parameters:

role -

Returns:

true if relationship provided by this class.

addRelationships

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

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

Parameters:

roles -