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

Class AbstractRelationship<A extends AppUser,B extends DataObject,L extends AbstractRelationship.Link<A,B>>

java.lang.Object

uk.ac.ed.epcc.webapp.model.data.DataObjectFactory<T>

uk.ac.ed.epcc.webapp.model.data.IndexedLinkManager<T,L,R>

uk.ac.ed.epcc.webapp.model.data.LinkManager<L,A,B>

uk.ac.ed.epcc.webapp.model.relationship.RelationshipLinkManager<A,B,L>

uk.ac.ed.epcc.webapp.model.relationship.AbstractRelationship<A,B,L>

Type Parameters:

A - AppUser type

B - target type

L - Link type

All Implemented Interfaces:

Contexed, ContextCached, FormCreatorProducer, FormUpdateProducer<L>, FilterMatcher<L>, TypeConverter<L,java.lang.Number>, DataObjectSelector<L>, Selector<DataObjectItemInput<L>>, Owner<L>, IndexedProducer<L>, AccessRoleProvider<A,B>, RelationshipProvider<A,B>, Tagged, Targetted<L>

Direct Known Subclasses:

Relationship

public abstract class AbstractRelationship<A extends AppUser,B extends DataObject,L extends AbstractRelationship.Link<A,B>>
extends RelationshipLinkManager<A,B,L>

abstract Link class that encodes an editable relationship between an AppUser and a domain object and used to implement RelationshipProvider and RoleSelector for the domain object. How roles are actually encoded into the link object is deferred to the sub-class.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractRelationship.Link<A extends AppUser,B extends DataObject>

Nested classes/interfaces inherited from class uk.ac.ed.epcc.webapp.model.data.LinkManager

LinkManager.JoinLinkFilterIterator, LinkManager.JoinLinkMapper, LinkManager.LeftAcceptFilter, LinkManager.LinkInput, LinkManager.LinkResult, LinkManager.RightAcceptFilter

Nested classes/interfaces inherited from class uk.ac.ed.epcc.webapp.model.data.IndexedLinkManager

IndexedLinkManager.LinkFilter, IndexedLinkManager.LinkProvider<T extends IndexedLinkManager.Link<L,R>,L extends Indexed,R extends Indexed>, IndexedLinkManager.LinkUpdater, IndexedLinkManager.SQLLinkFilter

Nested classes/interfaces inherited from class uk.ac.ed.epcc.webapp.model.data.DataObjectFactory

DataObjectFactory.AbstractDataObjectInput, DataObjectFactory.AbstractFinder<X>, DataObjectFactory.DataObjectAcceptFilter, DataObjectFactory.DataObjectInput, DataObjectFactory.DataObjectIntegerInput, DataObjectFactory.DestAcceptFilter<T extends DataObject>, DataObjectFactory.FilterAdapter, DataObjectFactory.FilterCounter, DataObjectFactory.FilterExists, DataObjectFactory.FilterIterator, DataObjectFactory.FilterSelector, DataObjectFactory.FilterSet, DataObjectFactory.Finder, DataObjectFactory.MakeRemoteFilterVisitor<R extends DataObject>, DataObjectFactory.MatchFilter, DataObjectFactory.ReferencedAdapter<I extends Indexed>, DataObjectFactory.ReferenceIterator<I extends Indexed>, DataObjectFactory.SortingDataObjectInput, DataObjectFactory.TimeAcceptFilter<T extends DataObject>, DataObjectFactory.TimeFilter

Field Summary

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

USE_JOIN

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

AUTO_CREATE_TABLES_FEATURE, COMPOSITES_SUFFIX, REJECT_MULTIPLE_RESULT_FEATURE, res

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractRelationship(AppContext c, java.lang.String tag, java.lang.String person_field, DataObjectFactory<B> b_fac, java.lang.String field) Extension constructor to allow sub-classes to set factory and field

Method Summary

Modifier and Type	Method and Description
boolean	canCreate(SessionService c) Can the producer provide a FormUpdate for the current user.
boolean	hasRole(A user, B target, java.lang.String role)
protected L	selectLink(A leftEnd, B rightEnd) method to call when from selector code normally the same as getLink but may need to be overridden to automatically create objects (beware of unwanted side effects in this case).
void	setRole(A user, B target, java.lang.String role, boolean value)

Methods inherited from class uk.ac.ed.epcc.webapp.model.relationship.RelationshipLinkManager

addRelationships, getFilterFromRole, getTargetFactory, getTargetFilter, getTargetRoleFilter, getUserFilter, getUserFilter, getUserRoleFilter, hasRelationFilter, personInRelationFilter, providesRelationship

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

find, find, getDefaultTableSpecification, getFilter, getFilterResult, getInput, getLeftFactory, getLeftFilter, getLeftFilter, getLeftInput, getLeftJoinFilter, getLeftRemoteFilter, getLinkCount, getLinkIterator, getRightFactory, getRightFilter, getRightFilter, getRightInput, getRightJoinFilter, getRightRemoteFilter, getSelectors, getTarget, isLeft, isRight

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

addLeftSet, addRightSet, getDefaultTableSpecification, getFinalTableSpecification, getFormUpdate, getHistoryHandler, getLeftField, getLeftFilter, getLeftProducer, getLeftSet, getLink, getRightField, getRightFilter, getRightProducer, getRightSet, getTableSpecification, makeHistoryHandler, makeLink, modifyHistoryTable, setContext, setHistoryHandler, updateHistory, useAutoHistory

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

all, allowPreSelect, canUpdate, checkComposite, convertToDestinationFilter, customiseForm, equals, exists, find, find, find, find, find, getAllIterator, getComposite, getComposites, getComposites, getConfigTag, getContext, getCount, getDefaultRelationshipFilter, getDefaults, getDestFilter, getExcludeFilter, getFieldConstraints, getFieldHelp, getFilter, getFilter, getFilter, getFinalSelectFilter, getFinalTableSpecification, getFindFilter, getFormCreator, getID, getIndex, getInput, getInput, getLogger, getMaxIdentifierLength, getNullable, getOptional, getOrder, getProperty, getReferenced, getReferenceFieldType, getReferenceFieldType, getRemoteFilter, getRemoteSQLFilter, getResult, getResult, getSelectFilter, getSelector, getSelector, getSupress, getTableStructureContributers, getTag, getTranslations, getUniqueIdName, hasComposite, hashCode, isMine, isMine, isMyReference, isValid, makeBDO, makeBDO, makeObject, makeRecord, makeReference, makeReference, matches, narrowSelector, narrowSelector, observeComposite, OrderBy, postCreateTableSetup, postSetContext, release, restrictDefaultInput, setComposites, setContext, setContext, setContextWithMake, setProperty, toString, updateTable

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface uk.ac.ed.epcc.webapp.model.relationship.RelationshipProvider

getRelationships

Methods inherited from interface uk.ac.ed.epcc.webapp.Tagged

getTag

Methods inherited from interface uk.ac.ed.epcc.webapp.Contexed

getContext

Constructor Detail

AbstractRelationship

protected AbstractRelationship(AppContext c,
                               java.lang.String tag,
                               java.lang.String person_field,
                               DataObjectFactory<B> b_fac,
                               java.lang.String field)

Extension constructor to allow sub-classes to set factory and field

Method Detail

hasRole

public final boolean hasRole(A user,
                             B target,
                             java.lang.String role)

setRole

public final void setRole(A user,
                          B target,
                          java.lang.String role,
                          boolean value)

selectLink

protected final L selectLink(A leftEnd,
                             B rightEnd)
                      throws java.lang.Exception

Description copied from class: IndexedLinkManager

method to call when from selector code normally the same as getLink but may need to be overridden to automatically create objects (beware of unwanted side effects in this case). Ususally want to Override #canCreate(uk.ac.ed.epcc.webapp.SessionService) in that case.

Overrides:

selectLink in class IndexedLinkManager<L extends AbstractRelationship.Link<A,B>,A extends AppUser,B extends DataObject>

Returns:

Link

Throws:

DataException

java.lang.Exception

canCreate

public final boolean canCreate(SessionService c)

Description copied from interface: FormCreatorProducer

Can the producer provide a FormUpdate for the current user. This is intended to reflect a functional inability to generate the FormUpdate as access control is handled by the FormPolicy

Specified by:

canCreate in interface FormCreatorProducer

Overrides:

canCreate in class DataObjectFactory<L extends AbstractRelationship.Link<A,B>>

Returns:

true if current user allowed to create objects