uk.ac.ed.epcc.webapp.forms.registry

Class FormFactoryProviderTransitionProvider<T>

java.lang.Object

uk.ac.ed.epcc.webapp.forms.registry.FormFactoryProviderTransitionProvider<T>

All Implemented Interfaces:

Contexed, IndexTransitionFactory<FormOperations,T>, IndexTransitionProvider<FormOperations,T>, TransitionFactory<FormOperations,T>, TransitionProvider<FormOperations,T>

public class FormFactoryProviderTransitionProvider<T>
extends java.lang.Object
implements IndexTransitionProvider<FormOperations,T>, TransitionProvider<FormOperations,T>

Constructor Summary

Constructors

Constructor and Description
FormFactoryProviderTransitionProvider(AppContext c, java.lang.String target_name, FormFactoryProvider<T> proviser)

Method Summary

Modifier and Type	Method and Description
<R> R	accept(TransitionFactoryVisitor<R,T,FormOperations> vis) Accept a TransitionFactoryVisitor.
boolean	allowTransition(AppContext c, T target, FormOperations name) Access control check.
boolean	equals(java.lang.Object obj)
AppContext	getContext()
java.lang.String	getID(T target) Get the id string for form posts from a target
FormOperations	getIndexTransition() Get the key for the default index transition.
<X extends ContentBuilder> X	getSummaryContent(AppContext c, X cb, T target) Get target summary to be shown on transition page.
T	getTarget(java.lang.String id) Find target type by id string
java.lang.String	getTargetName() What is the name for this type of transition.
Transition<T>	getTransition(T target, FormOperations key) Find a transition operator for this type by key.
java.util.Set<FormOperations>	getTransitions(T 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.
int	hashCode()
FormOperations	lookupTransition(T 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, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FormFactoryProviderTransitionProvider

public FormFactoryProviderTransitionProvider(AppContext c,
                                             java.lang.String target_name,
                                             FormFactoryProvider<T> proviser)

Method Detail

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

allowTransition

public boolean allowTransition(AppContext c,
                               T target,
                               FormOperations name)

Description copied from interface: TransitionFactory

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

Specified by:

allowTransition in interface TransitionFactory<FormOperations,T>

Parameters:

c - AppContext

target - target object

name - identifying key object for transition

Returns:

boolean is operation allowed

getID

public java.lang.String getID(T target)

Description copied from interface: TransitionProvider

Get the id string for form posts from a target

Specified by:

getID in interface TransitionProvider<FormOperations,T>

Returns:

id value

getSummaryContent

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

Parameters:

c - AppContext

cb - ContentBuilder

Returns:

ContentBuilder

getTarget

public T getTarget(java.lang.String id)

Description copied from interface: TransitionProvider

Find target type by id string

Specified by:

getTarget in interface TransitionProvider<FormOperations,T>

Returns:

target or null

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<FormOperations,T>

Returns:

String

getTransition

public Transition<T> getTransition(T target,
                                   FormOperations 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<FormOperations,T>

Parameters:

target - target (may be null)

key - key

Returns:

Transition or null

getTransitions

public java.util.Set<FormOperations> getTransitions(T 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<FormOperations,T>

Returns:

Set of keys

lookupTransition

public FormOperations lookupTransition(T 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<FormOperations,T>

Parameters:

target - (may be null)

Returns:

Transition key

getContext

public AppContext getContext()

Specified by:

getContext in interface Contexed

getIndexTransition

public FormOperations 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<FormOperations,T>

Returns:

transition key

accept

public <R> R accept(TransitionFactoryVisitor<R,T,FormOperations> 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<FormOperations,T>

Specified by:

accept in interface TransitionProvider<FormOperations,T>

Returns: