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

Class ResponseManager.Response<D extends DynamicFormManager.DynamicForm>

java.lang.Object

uk.ac.ed.epcc.webapp.model.data.DataObject

uk.ac.ed.epcc.webapp.model.far.response.ResponseManager.Response<D>

Type Parameters:

D -

All Implemented Interfaces:

Contexed, ContextIndexed, Identified, Indexed, Releasable

Direct Known Subclasses:

PersonalResponseManager.PersonalResponse

Enclosing class:

ResponseManager<R extends ResponseManager.Response<F>,F extends DynamicFormManager.DynamicForm>

public abstract static class ResponseManager.Response<D extends DynamicFormManager.DynamicForm>
extends DataObject

This represents a response to a DynamicFormManager.DynamicForm The logic for how a response is generated (and how the form we are responding to is selected) is up to the sub-class. For example this may be an application to a particular funding call and the form to be completed is encoded in funding-call object. Or the system might have a single application form where the current valid form is specified in some manner.

Field Summary

Fields inherited from class uk.ac.ed.epcc.webapp.model.data.DataObject

DEBUG, record

Fields inherited from interface uk.ac.ed.epcc.webapp.forms.Identified

MAX_IDENTIFIER

Constructor Summary

Constructors

Constructor and Description
Response(ResponseManager<? extends ResponseManager.Response<D>,D> manager, Repository.Record r)

Method Summary

Modifier and Type	Method and Description
abstract boolean	canEdit(SessionService<?> sess) Access control method to edit the response
abstract boolean	canView(SessionService<?> sess) Access control method to view the response
<T> T	getData(QuestionManager.Question q) get the data provided in response to a particular question.
abstract MimeStreamData	getDataStream() get a MimeStreamData representing a downloadable version of the response
abstract java.lang.String	getDescriptor() a text descriptor for the response.
D	getForm() Get the DynamicFormManager.DynamicForm we are in response to.
ResponseManager<? extends ResponseManager.Response<D>,D>	getResponseManager()
<T> ResponseDataManager.ResponseData<T,? extends ResponseManager.Response<D>,D>	getWrapper(QuestionManager.Question q) get the data-object that contains the response data.
<T> void	setData(QuestionManager.Question q, T data) set the data in response to a question
void	setForm(D form) Set the DynamicFormManager.DynamicForm.
abstract FormResult	submit() method to be called when the form is finally submitted.
abstract boolean	validate() This method must return true before the form edit transition allows the submit button to be pressed.

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

addToMap, addToMap, addToMap, commit, delete, empty, equals, formUpdate, getContext, getDatabaseService, getFactoryTag, getID, getIdentifier, getIdentifier, getLogger, getMap, getMap, getOwningFactory, getRecord, getRecord, getRecord, getSQLContext, getUniqueIdName, hashCode, isLocked, lock, post_commit, postCreate, pre_commit, release, setContents, setDirty, setMap, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Response

public Response(ResponseManager<? extends ResponseManager.Response<D>,D> manager,
                Repository.Record r)

Parameters:

r -

Method Detail

getResponseManager

public ResponseManager<? extends ResponseManager.Response<D>,D> getResponseManager()

getForm

public D getForm()
          throws DataException

Get the DynamicFormManager.DynamicForm we are in response to. This should be a frozen form as we assume it is static.

Returns:

Throws:

DataException

setForm

public void setForm(D form)

Set the DynamicFormManager.DynamicForm. This should be set once when the response if first created.

Parameters:

form -

setData

public <T> void setData(QuestionManager.Question q,
                        T data)
                 throws java.lang.Exception

set the data in response to a question

Parameters:

q -

data -

Throws:

java.lang.Exception

getData

public <T> T getData(QuestionManager.Question q)
              throws java.lang.Exception

get the data provided in response to a particular question.

Parameters:

q -

Returns:

Throws:

java.lang.Exception

getWrapper

public <T> ResponseDataManager.ResponseData<T,? extends ResponseManager.Response<D>,D> getWrapper(QuestionManager.Question q)
                                                                                           throws java.lang.Exception

get the data-object that contains the response data.

Parameters:

q -

Returns:

Throws:

java.lang.Exception

canView

public abstract boolean canView(SessionService<?> sess)

Access control method to view the response

Parameters:

sess -

Returns:

boolean

canEdit

public abstract boolean canEdit(SessionService<?> sess)

Access control method to edit the response

Parameters:

sess -

Returns:

getDescriptor

public abstract java.lang.String getDescriptor()

a text descriptor for the response. For example the name of the application being made in response to an application form.

Returns:

submit

public abstract FormResult submit()
                           throws java.lang.Exception

method to be called when the form is finally submitted. This should usually change internal state and freeze the response (changing the value returned by canEdit(SessionService) so the response contents don't change while the response is reviewed. Other submit time side-effects could also be included here The reviewers could return the response to the submitter returning it to a previous state

Returns:

FormResult

Throws:

java.lang.Exception

validate

public abstract boolean validate()
                          throws java.lang.Exception

This method must return true before the form edit transition allows the submit button to be pressed.

Returns:

boolean

Throws:

java.lang.Exception

getDataStream

public abstract MimeStreamData getDataStream()
                                      throws DataException

get a MimeStreamData representing a downloadable version of the response

Returns:

Throws:

DataException