uk.ac.ed.epcc.webapp.model.far.response

Class ResponseTransitionProvider<D extends DynamicFormManager.DynamicForm,R extends ResponseManager.Response<D>>

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.AbstractViewPathTransitionProvider<T,K>

uk.ac.ed.epcc.webapp.model.far.AbstractPartTransitionProvider<ResponseTarget<D,R>,ResponseTransitionKey<D,R>>

uk.ac.ed.epcc.webapp.model.far.response.ResponseTransitionProvider<D,R>

Type Parameters:

D - type of DynamicFormManager.DynamicForm

R - type of ResponseManager.Response

All Implemented Interfaces:

Contexed, ContextCached, PathTransitionProvider<ResponseTransitionKey<D,R>,ResponseTarget<D,R>>, ShowDisabledTransitions<ResponseTransitionKey<D,R>,ResponseTarget<D,R>>, TitleTransitionFactory<ResponseTransitionKey<D,R>,ResponseTarget<D,R>>, TransitionFactory<ResponseTransitionKey<D,R>,ResponseTarget<D,R>>, ViewTransitionFactory<ResponseTransitionKey<D,R>,ResponseTarget<D,R>>

public class ResponseTransitionProvider<D extends DynamicFormManager.DynamicForm,R extends ResponseManager.Response<D>>
extends AbstractPartTransitionProvider<ResponseTarget<D,R>,ResponseTransitionKey<D,R>>
implements ShowDisabledTransitions<ResponseTransitionKey<D,R>,ResponseTarget<D,R>>, TitleTransitionFactory<ResponseTransitionKey<D,R>,ResponseTarget<D,R>>

a generic TransitionProvider for editing DynamicFormManager.DynamicForm ResponseManager.Responses. The ResponseManager or some other class has to act as the TransitionFactoryCreator allowing the ResponseManager to be passed to the constructor. All the customisation therefore lives in the ResponseManager.Response object and this class can be used to implement the edit and navigation logic.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	ResponseTransitionProvider.ChainedResult
class	ResponseTransitionProvider.EditResult
class	ResponseTransitionProvider.EditSectionTransition
class	ResponseTransitionProvider.ParentTransition
class	ResponseTransitionProvider.SiblingTransition
class	ResponseTransitionProvider.SubmitTransition

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
ResponseTransitionKey<D,R>	EDIT
ResponseTransitionKey<D,R>	NEXT
ResponseTransitionKey<D,R>	PREV
ResponseTransitionKey<D,R>	SUBMIT
ResponseTransitionKey<D,R>	UP

Fields inherited from class uk.ac.ed.epcc.webapp.model.far.AbstractPartTransitionProvider

form_manager

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

conn

Constructor Summary

Constructors

Constructor and Description
ResponseTransitionProvider(java.lang.String target_name, ResponseManager<R,D> manager)

Method Summary

Modifier and Type	Method and Description
boolean	allowTransition(AppContext c, ResponseTarget<D,R> target, ResponseTransitionKey<D,R> key) Access control check.
boolean	canView(ResponseTarget<D,R> target, SessionService<?> sess) Can the current person view this target
java.lang.String	getHeading(ResponseTransitionKey<D,R> key, ResponseTarget<D,R> target) Get page heading
java.util.LinkedList<java.lang.String>	getID(ResponseTarget<D,R> target) Get the id string for form posts from a target
<X extends ContentBuilder> X	getLogContent(X cb, ResponseTarget<D,R> 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, ResponseTarget<D,R> target) Get target summary to be shown on transition page.
ResponseTarget<D,R>	getTarget(java.util.LinkedList<java.lang.String> id) Find target type by id string
java.lang.String	getTitle(ResponseTransitionKey<D,R> key, ResponseTarget<D,R> target) Get page title
boolean	showDisabledTransition(AppContext c, ResponseTarget<D,R> target, ResponseTransitionKey<D,R> key) If the transition is NOT allowed but this method returns true the button is stills shown but disabled.

Methods inherited from class uk.ac.ed.epcc.webapp.model.far.AbstractPartTransitionProvider

addBreadcrumb, equals, getID, getTarget, getTargetName, hashCode

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

accept

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

getBottomContent, getHelp, getText, 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, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

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

accept, getTargetName, 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.PathTransitionProvider

accept

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

showTransition

Field Detail

EDIT

public final ResponseTransitionKey<D extends DynamicFormManager.DynamicForm,R extends ResponseManager.Response<D>> EDIT

PREV

public final ResponseTransitionKey<D extends DynamicFormManager.DynamicForm,R extends ResponseManager.Response<D>> PREV

UP

public final ResponseTransitionKey<D extends DynamicFormManager.DynamicForm,R extends ResponseManager.Response<D>> UP

NEXT

public final ResponseTransitionKey<D extends DynamicFormManager.DynamicForm,R extends ResponseManager.Response<D>> NEXT

SUBMIT

public final ResponseTransitionKey<D extends DynamicFormManager.DynamicForm,R extends ResponseManager.Response<D>> SUBMIT

Constructor Detail

ResponseTransitionProvider

public ResponseTransitionProvider(java.lang.String target_name,
                                  ResponseManager<R,D> manager)

Method Detail

allowTransition

public boolean allowTransition(AppContext c,
                               ResponseTarget<D,R> target,
                               ResponseTransitionKey<D,R> key)

Description copied from interface: TransitionFactory

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

Specified by:

allowTransition in interface TransitionFactory<ResponseTransitionKey<D extends DynamicFormManager.DynamicForm,R extends ResponseManager.Response<D>>,ResponseTarget<D extends DynamicFormManager.DynamicForm,R extends ResponseManager.Response<D>>>

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,
                                                      ResponseTarget<D,R> 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<ResponseTransitionKey<D extends DynamicFormManager.DynamicForm,R extends ResponseManager.Response<D>>,ResponseTarget<D extends DynamicFormManager.DynamicForm,R extends ResponseManager.Response<D>>>

Parameters:

c - AppContext

cb - ContentBuilder

Returns:

ContentBuilder

canView

public boolean canView(ResponseTarget<D,R> target,
                       SessionService<?> sess)

Description copied from interface: ViewTransitionFactory

Can the current person view this target

Specified by:

canView in interface ViewTransitionFactory<ResponseTransitionKey<D extends DynamicFormManager.DynamicForm,R extends ResponseManager.Response<D>>,ResponseTarget<D extends DynamicFormManager.DynamicForm,R extends ResponseManager.Response<D>>>

Returns:

boolean

getTarget

public ResponseTarget<D,R> getTarget(java.util.LinkedList<java.lang.String> id)

Description copied from interface: PathTransitionProvider

Find target type by id string

Specified by:

getTarget in interface PathTransitionProvider<ResponseTransitionKey<D extends DynamicFormManager.DynamicForm,R extends ResponseManager.Response<D>>,ResponseTarget<D extends DynamicFormManager.DynamicForm,R extends ResponseManager.Response<D>>>

Returns:

target or null

getID

public java.util.LinkedList<java.lang.String> getID(ResponseTarget<D,R> target)

Description copied from interface: PathTransitionProvider

Get the id string for form posts from a target

Specified by:

getID in interface PathTransitionProvider<ResponseTransitionKey<D extends DynamicFormManager.DynamicForm,R extends ResponseManager.Response<D>>,ResponseTarget<D extends DynamicFormManager.DynamicForm,R extends ResponseManager.Response<D>>>

Returns:

id value

getLogContent

public <X extends ContentBuilder> X getLogContent(X cb,
                                                  ResponseTarget<D,R> 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<ResponseTransitionKey<D extends DynamicFormManager.DynamicForm,R extends ResponseManager.Response<D>>,ResponseTarget<D extends DynamicFormManager.DynamicForm,R extends ResponseManager.Response<D>>>

Overrides:

getLogContent in class AbstractViewTransitionFactory<ResponseTarget<D extends DynamicFormManager.DynamicForm,R extends ResponseManager.Response<D>>,ResponseTransitionKey<D extends DynamicFormManager.DynamicForm,R extends ResponseManager.Response<D>>>

Returns:

ContentBuilder

showDisabledTransition

public boolean showDisabledTransition(AppContext c,
                                      ResponseTarget<D,R> target,
                                      ResponseTransitionKey<D,R> key)

Description copied from interface: ShowDisabledTransitions

If the transition is NOT allowed but this method returns true the button is stills shown but disabled.

Specified by:

showDisabledTransition in interface ShowDisabledTransitions<ResponseTransitionKey<D extends DynamicFormManager.DynamicForm,R extends ResponseManager.Response<D>>,ResponseTarget<D extends DynamicFormManager.DynamicForm,R extends ResponseManager.Response<D>>>

Parameters:

c - AppContext

target - target object

key - identifying key object for transition

Returns:

boolean is operation allowed

getTitle

public java.lang.String getTitle(ResponseTransitionKey<D,R> key,
                                 ResponseTarget<D,R> target)

Description copied from interface: TitleTransitionFactory

Get page title

Specified by:

getTitle in interface TitleTransitionFactory<ResponseTransitionKey<D extends DynamicFormManager.DynamicForm,R extends ResponseManager.Response<D>>,ResponseTarget<D extends DynamicFormManager.DynamicForm,R extends ResponseManager.Response<D>>>

Returns:

String title

getHeading

public java.lang.String getHeading(ResponseTransitionKey<D,R> key,
                                   ResponseTarget<D,R> target)

Description copied from interface: TitleTransitionFactory

Get page heading

Specified by:

getHeading in interface TitleTransitionFactory<ResponseTransitionKey<D extends DynamicFormManager.DynamicForm,R extends ResponseManager.Response<D>>,ResponseTarget<D extends DynamicFormManager.DynamicForm,R extends ResponseManager.Response<D>>>

Returns:

String heading