uk.ac.ed.epcc.webapp.preferences

Class PreferenceTransitionProvider

java.lang.Object

uk.ac.ed.epcc.webapp.preferences.PreferenceTransitionProvider

All Implemented Interfaces:

Contexed, IndexTransitionFactory<PreferenceAction,AbstractSetting>, IndexTransitionProvider<PreferenceAction,AbstractSetting>, TransitionFactory<PreferenceAction,AbstractSetting>, TransitionProvider<PreferenceAction,AbstractSetting>, ViewTransitionFactory<PreferenceAction,AbstractSetting>, ViewTransitionProvider<PreferenceAction,AbstractSetting>

public class PreferenceTransitionProvider
extends java.lang.Object
implements ViewTransitionProvider<PreferenceAction,AbstractSetting>, IndexTransitionProvider<PreferenceAction,AbstractSetting>

A ViewTransitionFactory for editing PreferenceSettings and AbstractSettings.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	PreferenceTransitionProvider.ClearPreferenceTransition
class	PreferenceTransitionProvider.IndexResult
class	PreferenceTransitionProvider.IndexTransition
class	PreferenceTransitionProvider.Linker
class	PreferenceTransitionProvider.SetFeatureTransition
class	PreferenceTransitionProvider.SetPreferenceTransition

Constructor Summary

Constructors

Constructor and Description
PreferenceTransitionProvider(AppContext conn, java.lang.String target)

Method Summary

Modifier and Type	Method and Description
<R> R	accept(TransitionFactoryVisitor<R,AbstractSetting,PreferenceAction> vis) Accept a TransitionFactoryVisitor.
void	addTable(Table t, AbstractSetting target)
boolean	allowTransition(AppContext c, AbstractSetting target, PreferenceAction key) Access control check.
boolean	canView(AbstractSetting target, SessionService<?> sess) Can the current person view this target
<X extends ContentBuilder> X	getBottomContent(X cb, AbstractSetting target, SessionService<?> sess) Get the content to be displayed at the bottom of the target page.
AppContext	getContext()
java.lang.String	getHelp(PreferenceAction key) Get tooltip help string for an operation
java.lang.String	getID(AbstractSetting target) Get the id string for form posts from a target
Table	getIndexTable(SessionService sess)
PreferenceAction	getIndexTransition() Get the key for the default index transition.
<X extends ContentBuilder> X	getLogContent(X cb, AbstractSetting 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, AbstractSetting target) Get target summary to be shown on transition page.
AbstractSetting	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(PreferenceAction key) get custom button content.
<X extends ContentBuilder> X	getTopContent(X cb, AbstractSetting target, SessionService<?> sess) Get the content to be displayed at the top of the target page.
Transition<AbstractSetting>	getTransition(AbstractSetting target, PreferenceAction key) Find a transition operator for this type by key.
java.util.Set<PreferenceAction>	getTransitions(AbstractSetting target) Get a list of all the transition keys supported by the target type to be presented to the user as a set of possible options in a view transition.
PreferenceAction	lookupTransition(AbstractSetting target, java.lang.String name) Lookup a transition key by String This has to be the same as the result of the toString method on the key as this is what is passed from transitions.jsp for a form transition.

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

showTransition

Constructor Detail

PreferenceTransitionProvider

public PreferenceTransitionProvider(AppContext conn,
                                    java.lang.String target)

Parameters:

conn -

target -

Method Detail

getTransitions

public java.util.Set<PreferenceAction> getTransitions(AbstractSetting target)

Description copied from interface: TransitionFactory

Get a list of all the transition keys supported by the target type to be presented to the user as a set of possible options in a view transition. Options in this list that are not allowed by TransitionFactory.allowTransition(AppContext, Object, Object) will not be presented. Additional hidden operations may also be supported but these will never be presented to the user as options and can only generated as a ChainedTransitionResult. In most cases the transition set will be the same for all null/non-null targets though in principal dynamic transitions could be generated based on the state of the target e.g. a parameterised transition with the parameter encoded in the key.

Specified by:

getTransitions in interface TransitionFactory<PreferenceAction,AbstractSetting>

Returns:

Set of keys

getTransition

public Transition<AbstractSetting> getTransition(AbstractSetting target,
                                                 PreferenceAction key)

Description copied from interface: TransitionFactory

Find a transition operator for this type by key. This method is permitted to return null for example if the current user is not permitted to perform the transition.

Specified by:

getTransition in interface TransitionFactory<PreferenceAction,AbstractSetting>

Parameters:

target - target (may be null)

key - key

Returns:

Transition or null

lookupTransition

public PreferenceAction lookupTransition(AbstractSetting target,
                                         java.lang.String name)

Description copied from interface: TransitionFactory

Lookup a transition key by String This has to be the same as the result of the toString method on the key as this is what is passed from transitions.jsp for a form transition.

Specified by:

lookupTransition in interface TransitionFactory<PreferenceAction,AbstractSetting>

Parameters:

target - (may be null)

Returns:

Transition key

getTargetName

public 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<PreferenceAction,AbstractSetting>

Returns:

String

allowTransition

public boolean allowTransition(AppContext c,
                               AbstractSetting target,
                               PreferenceAction key)

Description copied from interface: TransitionFactory

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

Specified by:

allowTransition in interface TransitionFactory<PreferenceAction,AbstractSetting>

Parameters:

c - AppContext

target - target object

key - identifying key object for transition

Returns:

boolean is operation allowed

getIndexTable

public Table getIndexTable(SessionService sess)

addTable

public void addTable(Table t,
                     AbstractSetting target)

getSummaryContent

public <X extends ContentBuilder> X getSummaryContent(AppContext c,
                                                      X cb,
                                                      AbstractSetting 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<PreferenceAction,AbstractSetting>

Parameters:

c - AppContext

cb - ContentBuilder

Returns:

ContentBuilder

accept

public <R> R accept(TransitionFactoryVisitor<R,AbstractSetting,PreferenceAction> vis)

Description copied from interface: TransitionFactory

Accept a TransitionFactoryVisitor. Any code that depends on the particular sub-interface of TransitionFactory should implement TransitionFactoryVisitor this ensures it will always handle all possible sub-classes.

Specified by:

accept in interface TransitionFactory<PreferenceAction,AbstractSetting>

Specified by:

accept in interface TransitionProvider<PreferenceAction,AbstractSetting>

Returns:

getContext

public AppContext getContext()

Specified by:

getContext in interface Contexed

canView

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

Description copied from interface: ViewTransitionFactory

Can the current person view this target

Specified by:

canView in interface ViewTransitionFactory<PreferenceAction,AbstractSetting>

Returns:

boolean

getTopContent

public <X extends ContentBuilder> X getTopContent(X cb,
                                                  AbstractSetting target,
                                                  SessionService<?> sess)

Description copied from interface: ViewTransitionFactory

Get the content to be displayed at the top of the target page. This content is at the top level of the page

Specified by:

getTopContent in interface ViewTransitionFactory<PreferenceAction,AbstractSetting>

Returns:

boolean

getBottomContent

public <X extends ContentBuilder> X getBottomContent(X cb,
                                                     AbstractSetting target,
                                                     SessionService<?> sess)

Description copied from interface: ViewTransitionFactory

Get the content to be displayed at the bottom of the target page. This content is at the top level of the page

Specified by:

getBottomContent in interface ViewTransitionFactory<PreferenceAction,AbstractSetting>

Returns:

boolean

getLogContent

public <X extends ContentBuilder> X getLogContent(X cb,
                                                  AbstractSetting 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<PreferenceAction,AbstractSetting>

Returns:

ContentBuilder

getHelp

public java.lang.String getHelp(PreferenceAction key)

Description copied from interface: ViewTransitionFactory

Get tooltip help string for an operation

Specified by:

getHelp in interface ViewTransitionFactory<PreferenceAction,AbstractSetting>

Returns:

String or null

getText

public java.lang.String getText(PreferenceAction 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<PreferenceAction,AbstractSetting>

Returns:

String

getTarget

public AbstractSetting getTarget(java.lang.String id)

Description copied from interface: TransitionProvider

Find target type by id string

Specified by:

getTarget in interface TransitionProvider<PreferenceAction,AbstractSetting>

Returns:

target or null

getID

public java.lang.String getID(AbstractSetting target)

Description copied from interface: TransitionProvider

Get the id string for form posts from a target

Specified by:

getID in interface TransitionProvider<PreferenceAction,AbstractSetting>

Returns:

id value

getIndexTransition

public PreferenceAction getIndexTransition()

Description copied from interface: IndexTransitionFactory

Get the key for the default index transition. This method can return null if a sub-class wants to supress the default transition.

Specified by:

getIndexTransition in interface IndexTransitionFactory<PreferenceAction,AbstractSetting>

Returns:

transition key