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

Class PersonalResponseManager.PersonalResponse<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>

uk.ac.ed.epcc.webapp.model.far.response.personal.PersonalResponseManager.PersonalResponse<D>

All Implemented Interfaces:

Contexed, ContextIndexed, Identified, Indexed, Releasable

Enclosing class:

PersonalResponseManager<R extends PersonalResponseManager.PersonalResponse<D>,D extends DynamicFormManager.DynamicForm>

public static class PersonalResponseManager.PersonalResponse<D extends DynamicFormManager.DynamicForm>
extends ResponseManager.Response<D>

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
PersonalResponse(PersonalResponseManager<?,D> manager, Repository.Record r)

Method Summary

Modifier and Type	Method and Description
boolean	canEdit(SessionService<?> sess) Access control method to edit the response
boolean	canView(SessionService<?> sess) Access control method to view the response
MimeStreamData	getDataStream() get a MimeStreamData representing a downloadable version of the response
java.lang.String	getDescriptor() a text descriptor for the response.
AppUser	getPerson()
boolean	isSubmitter(SessionService<?> sess)
void	setPerson(AppUser user)
MessageResult	submit() method to be called when the form is finally submitted.
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.far.response.ResponseManager.Response

getData, getForm, getResponseManager, getWrapper, setData, setForm

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

PersonalResponse

public PersonalResponse(PersonalResponseManager<?,D> manager,
                        Repository.Record r)

Parameters:

r -

Method Detail

canView

public boolean canView(SessionService<?> sess)

Description copied from class: ResponseManager.Response

Access control method to view the response

Specified by:

canView in class ResponseManager.Response<D extends DynamicFormManager.DynamicForm>

Returns:

boolean

canEdit

public boolean canEdit(SessionService<?> sess)

Description copied from class: ResponseManager.Response

Access control method to edit the response

Specified by:

canEdit in class ResponseManager.Response<D extends DynamicFormManager.DynamicForm>

Returns:

getDescriptor

public java.lang.String getDescriptor()

Description copied from class: ResponseManager.Response

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

Specified by:

getDescriptor in class ResponseManager.Response<D extends DynamicFormManager.DynamicForm>

Returns:

isSubmitter

public boolean isSubmitter(SessionService<?> sess)

setPerson

public void setPerson(AppUser user)

getPerson

public AppUser getPerson()
                  throws DataException

Throws:

DataException

submit

public MessageResult submit()
                     throws java.lang.Exception

Description copied from class: ResponseManager.Response

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 ResponseManager.Response.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

Specified by:

submit in class ResponseManager.Response<D extends DynamicFormManager.DynamicForm>

Returns:

FormResult

Throws:

java.lang.Exception

validate

public boolean validate()
                 throws java.lang.Exception

Description copied from class: ResponseManager.Response

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

Specified by:

validate in class ResponseManager.Response<D extends DynamicFormManager.DynamicForm>

Returns:

boolean

Throws:

java.lang.Exception

getDataStream

public MimeStreamData getDataStream()
                             throws DataException

Description copied from class: ResponseManager.Response

get a MimeStreamData representing a downloadable version of the response

Specified by:

getDataStream in class ResponseManager.Response<D extends DynamicFormManager.DynamicForm>

Returns:

Throws:

DataException