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

Class DynamicFormTransitionProvider<T extends DynamicFormManager.DynamicForm>

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

uk.ac.ed.epcc.webapp.model.far.DynamicFormTransitionProvider<T>

All Implemented Interfaces:

Contexed, ContextCached, IndexTransitionFactory<DynamicFormTransitionKey<T>,T>, IndexTransitionProvider<DynamicFormTransitionKey<T>,T>, TransitionFactory<DynamicFormTransitionKey<T>,T>, TransitionProvider<DynamicFormTransitionKey<T>,T>, ViewTransitionFactory<DynamicFormTransitionKey<T>,T>, ViewTransitionProvider<DynamicFormTransitionKey<T>,T>

public class DynamicFormTransitionProvider<T extends DynamicFormManager.DynamicForm>
extends AbstractViewTransitionProvider<T,DynamicFormTransitionKey<T>>
implements IndexTransitionProvider<DynamicFormTransitionKey<T>,T>

TransitionProvider for manipulating DynamicFormManager.DynamicForm objects.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	DynamicFormTransitionProvider.ActivateTransition
class	DynamicFormTransitionProvider.AddXMLTransition
class	DynamicFormTransitionProvider.CreateChildTransition
class	DynamicFormTransitionProvider.Creator
class	DynamicFormTransitionProvider.DownloadTransition
class	DynamicFormTransitionProvider.DuplicateTransition
class	DynamicFormTransitionProvider.IndexTransition
class	DynamicFormTransitionProvider.Linker
class	DynamicFormTransitionProvider.RenewTransition
class	DynamicFormTransitionProvider.RetireTransition
class	DynamicFormTransitionProvider.ViewTransition

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

AbstractViewTransitionFactory.ViewResult

Field Summary

Fields

Modifier and Type	Field and Description
static DynamicFormTransitionKey	ACTIVATE
static DynamicFormTransitionKey	ADD
static DynamicFormTransitionKey	CLONE
static DynamicFormTransitionKey	CREATE
static DynamicFormTransitionKey	DOWNLOAD
static DynamicFormTransitionKey	INDEX
static DynamicFormTransitionKey	RENEW
static DynamicFormTransitionKey	RETIRE
static DynamicFormTransitionKey	UPLOAD

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

conn

Constructor Summary

Constructors

Constructor and Description
DynamicFormTransitionProvider(java.lang.String target_name, DynamicFormManager<T> manager)

Method Summary

Modifier and Type	Method and Description
boolean	allowTransition(AppContext c, T target, DynamicFormTransitionKey<T> key) Access control check.
boolean	canView(T target, SessionService<?> sess) Can the current person view this target
java.lang.String	getID(T target) Get the id string for form posts from a target
DynamicFormTransitionKey<T>	getIndexTransition() Get the key for the default index transition.
<X extends ContentBuilder> X	getLogContent(X cb, T 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, 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.
<X extends ContentBuilder> X	getTopContent(X cb, T target, SessionService<?> sess) Get the content to be displayed at the top of the target page.

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, getText

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, getText, showTransition

Field Detail

CREATE

public static final DynamicFormTransitionKey CREATE

INDEX

public static final DynamicFormTransitionKey INDEX

ADD

public static final DynamicFormTransitionKey ADD

RENEW

public static final DynamicFormTransitionKey RENEW

ACTIVATE

public static final DynamicFormTransitionKey ACTIVATE

RETIRE

public static final DynamicFormTransitionKey RETIRE

CLONE

public static final DynamicFormTransitionKey CLONE

DOWNLOAD

public static final DynamicFormTransitionKey DOWNLOAD

UPLOAD

public static final DynamicFormTransitionKey UPLOAD

Constructor Detail

DynamicFormTransitionProvider

public DynamicFormTransitionProvider(java.lang.String target_name,
                                     DynamicFormManager<T> manager)

Method Detail

canView

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

Description copied from interface: ViewTransitionFactory

Can the current person view this target

Specified by:

canView in interface ViewTransitionFactory<DynamicFormTransitionKey<T extends DynamicFormManager.DynamicForm>,T extends DynamicFormManager.DynamicForm>

Returns:

boolean

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<DynamicFormTransitionKey<T extends DynamicFormManager.DynamicForm>,T extends DynamicFormManager.DynamicForm>

Returns:

String

allowTransition

public boolean allowTransition(AppContext c,
                               T target,
                               DynamicFormTransitionKey<T> key)

Description copied from interface: TransitionFactory

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

Specified by:

allowTransition in interface TransitionFactory<DynamicFormTransitionKey<T extends DynamicFormManager.DynamicForm>,T extends DynamicFormManager.DynamicForm>

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,
                                                      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<DynamicFormTransitionKey<T extends DynamicFormManager.DynamicForm>,T extends DynamicFormManager.DynamicForm>

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<DynamicFormTransitionKey<T extends DynamicFormManager.DynamicForm>,T extends DynamicFormManager.DynamicForm>

Returns:

target or null

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<DynamicFormTransitionKey<T extends DynamicFormManager.DynamicForm>,T extends DynamicFormManager.DynamicForm>

Returns:

id value

getTopContent

public <X extends ContentBuilder> X getTopContent(X cb,
                                                  T 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<DynamicFormTransitionKey<T extends DynamicFormManager.DynamicForm>,T extends DynamicFormManager.DynamicForm>

Overrides:

getTopContent in class AbstractViewTransitionFactory<T extends DynamicFormManager.DynamicForm,DynamicFormTransitionKey<T extends DynamicFormManager.DynamicForm>>

Returns:

boolean

getIndexTransition

public DynamicFormTransitionKey<T> 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<DynamicFormTransitionKey<T extends DynamicFormManager.DynamicForm>,T extends DynamicFormManager.DynamicForm>

Returns:

transition key

getLogContent

public <X extends ContentBuilder> X getLogContent(X cb,
                                                  T 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<DynamicFormTransitionKey<T extends DynamicFormManager.DynamicForm>,T extends DynamicFormManager.DynamicForm>

Overrides:

getLogContent in class AbstractViewTransitionFactory<T extends DynamicFormManager.DynamicForm,DynamicFormTransitionKey<T extends DynamicFormManager.DynamicForm>>

Returns:

ContentBuilder