uk.ac.ed.epcc.webapp.session

Class AppUserTransitionProvider<AU extends AppUser>

java.lang.Object

uk.ac.ed.epcc.webapp.AbstractContexed

uk.ac.ed.epcc.webapp.model.data.transition.AbstractTransitionFactory<T,K>

uk.ac.ed.epcc.webapp.model.data.transition.AbstractViewTransitionFactory<T,K>

uk.ac.ed.epcc.webapp.model.data.transition.AbstractViewTransitionProvider<AU,AppUserKey<AU>>

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

All Implemented Interfaces:

Contexed, ContextCached, TitleTransitionFactory<AppUserKey<AU>,AU>, TitleTransitionProvider<AppUserKey<AU>,AU>, TransitionFactory<AppUserKey<AU>,AU>, TransitionProvider<AppUserKey<AU>,AU>, ViewTransitionFactory<AppUserKey<AU>,AU>, ViewTransitionProvider<AppUserKey<AU>,AU>

Direct Known Subclasses:

LandingPageAppUserTransitionProvider

public class AppUserTransitionProvider<AU extends AppUser>
extends AbstractViewTransitionProvider<AU,AppUserKey<AU>>
implements TitleTransitionProvider<AppUserKey<AU>,AU>, ContextCached

A TransitionProvider for operations on AppUsers

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	AppUserTransitionProvider.EraseTransition
class	AppUserTransitionProvider.LoginHistoryTransition
class	AppUserTransitionProvider.QueryRoleTransition
static class	AppUserTransitionProvider.SUTransition<AU extends AppUser>

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

AbstractViewTransitionFactory.ViewResult, AbstractViewTransitionFactory.ViewTransition

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	EDIT_DETAILS_ROLE Relationship that allows a different user to edit this persons details
static AppUserKey	ERASE
static AppUserKey	LOGIN_HISTORY
static java.lang.String	PERSON_TRANSITION_TAG
static AppUserKey	QUERY_ROLE_KEY
static java.lang.String	SEE_LOGIN_HISTORY_ROLE
static AppUserKey	SET_ROLE_KEY
static java.lang.String	SET_ROLES_ROLE Relationship that allows somebody to edit this persons roles
static AppUserKey	SU_KEY
static CurrentUserKey	UPDATE
static Feature	USER_SELF_UPDATE_FEATURE
static java.lang.String	VIEW_PERSON_RELATIONSHIP

Fields inherited from class uk.ac.ed.epcc.webapp.AbstractContexed

conn

Constructor Summary

Constructors

Constructor and Description
AppUserTransitionProvider(AppContext c)

Method Summary

Modifier and Type	Method and Description
boolean	allowTransition(AppContext c, AU target, AppUserKey<AU> key) Access control check.
boolean	canView(AU target, SessionService<?> sess) Can the current person view this target
AppUserFactory<AU>	getAppUserFactory()
java.lang.String	getHeading(AppUserKey key, AppUser target) Get page heading
java.lang.String	getID(AppUser target) Get the id string for form posts from a target
static AppUserTransitionProvider	getInstance(AppContext conn)
<X extends ContentBuilder> X	getLogContent(X cb, AU target, SessionService<?> sess) Get the content to be displayed on the view target page as part of the target pane.
<X extends ContentBuilder> X	getSummaryContent(AppContext c, X cb, AU target) Get target summary to be shown on transition page.
AU	getTarget(java.lang.String id) Find target type by id string
java.lang.String	getTargetName() What is the name for this type of transition.
java.lang.String	getText(AppUserKey key) get custom button content.
java.lang.String	getTitle(AppUserKey key, AppUser target) Get page title

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

accept

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

getBottomContent, getHelp, getTopContent

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

addTransition, getTransition, getTransition, getTransitions, lookupTransition, sortByKey

Methods inherited from class uk.ac.ed.epcc.webapp.AbstractContexed

getContext, getLogger, resetLogger

Methods inherited from class java.lang.Object

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

Methods inherited from interface uk.ac.ed.epcc.webapp.forms.transition.TransitionProvider

accept

Methods inherited from interface uk.ac.ed.epcc.webapp.forms.transition.TransitionFactory

getTransition, getTransitions, lookupTransition

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

getContext

Methods inherited from interface uk.ac.ed.epcc.webapp.forms.transition.ViewTransitionFactory

getBottomContent, getHelp, getTopContent, showTransition

Field Detail

SEE_LOGIN_HISTORY_ROLE

public static final java.lang.String SEE_LOGIN_HISTORY_ROLE

See Also:

Constant Field Values

EDIT_DETAILS_ROLE

public static final java.lang.String EDIT_DETAILS_ROLE

Relationship that allows a different user to edit this persons details

See Also:

Constant Field Values

SET_ROLES_ROLE

public static final java.lang.String SET_ROLES_ROLE

Relationship that allows somebody to edit this persons roles

See Also:

Constant Field Values

USER_SELF_UPDATE_FEATURE

public static final Feature USER_SELF_UPDATE_FEATURE

PERSON_TRANSITION_TAG

public static final java.lang.String PERSON_TRANSITION_TAG

See Also:

Constant Field Values

VIEW_PERSON_RELATIONSHIP

public static final java.lang.String VIEW_PERSON_RELATIONSHIP

See Also:

Constant Field Values

SU_KEY

public static final AppUserKey SU_KEY

SET_ROLE_KEY

public static final AppUserKey SET_ROLE_KEY

QUERY_ROLE_KEY

public static final AppUserKey QUERY_ROLE_KEY

UPDATE

public static final CurrentUserKey UPDATE

ERASE

public static final AppUserKey ERASE

LOGIN_HISTORY

public static final AppUserKey LOGIN_HISTORY

Constructor Detail

AppUserTransitionProvider

public AppUserTransitionProvider(AppContext c)

Parameters:

c -

Method Detail

getTarget

public AU getTarget(java.lang.String id)

Description copied from interface: TransitionProvider

Find target type by id string

Specified by:

getTarget in interface TransitionProvider<AppUserKey<AU extends AppUser>,AU extends AppUser>

Returns:

target or null

getID

public java.lang.String getID(AppUser target)

Description copied from interface: TransitionProvider

Get the id string for form posts from a target

Specified by:

getID in interface TransitionProvider<AppUserKey<AU extends AppUser>,AU extends AppUser>

Returns:

id value

getTargetName

public final java.lang.String getTargetName()

Description copied from interface: TransitionFactory

What is the name for this type of transition. This value needs to resolve to the TransitionProvider in the TransitionServlet The value can also be used as the user presented text for the type of object in the title of the transition form page though this can be overridden by setting target-name.transition_title

Specified by:

getTargetName in interface TransitionFactory<AppUserKey<AU extends AppUser>,AU extends AppUser>

Returns:

String

allowTransition

public boolean allowTransition(AppContext c,
                               AU target,
                               AppUserKey<AU> key)

Description copied from interface: TransitionFactory

Access control check. Is this transition allowed for the current user/target

Specified by:

allowTransition in interface TransitionFactory<AppUserKey<AU extends AppUser>,AU extends AppUser>

Parameters:

c - AppContext

target - target object

key - identifying key object for transition

Returns:

boolean is operation allowed

getSummaryContent

public <X extends ContentBuilder> X getSummaryContent(AppContext c,
                                                      X cb,
                                                      AU target)

Description copied from interface: TransitionFactory

Get target summary to be shown on transition page. In html this content is embedded within a div.block element.

Specified by:

getSummaryContent in interface TransitionFactory<AppUserKey<AU extends AppUser>,AU extends AppUser>

Parameters:

c - AppContext

cb - ContentBuilder

Returns:

ContentBuilder

canView

public boolean canView(AU target,
                       SessionService<?> sess)

Description copied from interface: ViewTransitionFactory

Can the current person view this target

Specified by:

canView in interface ViewTransitionFactory<AppUserKey<AU extends AppUser>,AU extends AppUser>

Returns:

boolean

getText

public java.lang.String getText(AppUserKey key)

Description copied from interface: ViewTransitionFactory

get custom button content. should default to the string representation of the key

Specified by:

getText in interface ViewTransitionFactory<AppUserKey<AU extends AppUser>,AU extends AppUser>

Overrides:

getText in class AbstractViewTransitionFactory<AU extends AppUser,AppUserKey<AU extends AppUser>>

Returns:

String

getInstance

public static AppUserTransitionProvider getInstance(AppContext conn)

getTitle

public java.lang.String getTitle(AppUserKey key,
                                 AppUser target)

Description copied from interface: TitleTransitionFactory

Get page title

Specified by:

getTitle in interface TitleTransitionFactory<AppUserKey<AU extends AppUser>,AU extends AppUser>

Returns:

String title

getHeading

public java.lang.String getHeading(AppUserKey key,
                                   AppUser target)

Description copied from interface: TitleTransitionFactory

Get page heading

Specified by:

getHeading in interface TitleTransitionFactory<AppUserKey<AU extends AppUser>,AU extends AppUser>

Returns:

String heading

getLogContent

public <X extends ContentBuilder> X getLogContent(X cb,
                                                  AU target,
                                                  SessionService<?> sess)

Description copied from interface: ViewTransitionFactory

Get the content to be displayed on the view target page as part of the target pane.

Specified by:

getLogContent in interface ViewTransitionFactory<AppUserKey<AU extends AppUser>,AU extends AppUser>

Overrides:

getLogContent in class AbstractViewTransitionFactory<AU extends AppUser,AppUserKey<AU extends AppUser>>

Returns:

ContentBuilder

getAppUserFactory

public AppUserFactory<AU> getAppUserFactory()