com.whitestein.lsps.vaadin

Class AbstractTodoHolder

java.lang.Object

com.whitestein.lsps.vaadin.LspsContextHolder

com.whitestein.lsps.vaadin.AbstractTodoHolder

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

LspsCustomUITodoHolder, LspsCustomUIWithContextTodoHolder, LspsTodoHolder

public abstract class AbstractTodoHolder
extends LspsContextHolder

Extension of LspsContextHolder which displays and handles the lifecycle of a LSPS to-do.

Author:

mbj

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	PARAM_NAVIGATION
protected static String	PARAM_UIDEFINITION
protected Long	taskContextId
protected Todo	todo
protected long	todoId
protected com.whitestein.lsps.human.ejb.TodoServiceLocal	todoServiceLocal

Fields inherited from class com.whitestein.lsps.vaadin.LspsContextHolder

modelInstanceUtilsService, modelProviderService, sharedRecordTypeFactory

Constructor Summary

Constructors

Constructor and Description
AbstractTodoHolder(long todoId, LspsAppConnector appConnector, LspsFormConnector formConnector, String userId, boolean readOnly) Creates context for the given to-do id.

Method Summary

Modifier and Type	Method and Description
void	addSaveMetadataToUploadedBinaryData(BinaryDataServiceLocal binaryDataService, List<Long> uploadedBinaryData) Adds metadata to the binary data uploaded in this holder.
RecordHolder	createSavedStateHolder() Returns a representation of the saved state in the model.
protected InterpreterStackTrace	createStackTrace(String property)
RecordHolder	getHistoryEntry(ExecutionContext context, Map<String,Object> defaultValues) Returns the navigation history entry for this todo.
Variant.ClosureVariant	getSubmitNavigationDefinition() Gets the navigation definition from the document/todo definition.
String	getTitle() Returns the title for the form content.
Todo	getTodo() Returns the displayed to-do.
boolean	isReadOnly() Returns true if the GUI should be opened in read-only mode.
protected boolean	isUsingEvalLevels(ExecutionContext taskContext)
void	save(UIScreenState uiState) Saves the current state of the to-do.
protected RecordHolder	submit() Submits the changes done within the context and closes the context.
protected abstract TodoList	submitTodo()
protected void	updateApplicationData(ModelInstance modelInstance) Updates the data available to the model through the getApplicationData() function.

Methods inherited from class com.whitestein.lsps.vaadin.LspsContextHolder

collectGarbage, createEvaluationContext, createScreen, deactivate, getAppConnector, getExecutionContext, getExecutionContext, getFormConnector, getHandle, getModelInstance, getScreen, getValueHolder, getValueHolderInLevel, invalidate, isClosureWithQuery, isSaved, isValid, minimalModelInstanceCopy, performPersist, persist, reactivate, reloadContent, submitContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PARAM_NAVIGATION

protected static final String PARAM_NAVIGATION

See Also:

Constant Field Values

PARAM_UIDEFINITION

protected static final String PARAM_UIDEFINITION

See Also:

Constant Field Values

todoId

protected final long todoId

todo

protected Todo todo

taskContextId

protected Long taskContextId

todoServiceLocal

protected com.whitestein.lsps.human.ejb.TodoServiceLocal todoServiceLocal

Constructor Detail

AbstractTodoHolder

public AbstractTodoHolder(long todoId,
                          LspsAppConnector appConnector,
                          LspsFormConnector formConnector,
                          String userId,
                          boolean readOnly)
                   throws LspsException

Creates context for the given to-do id.

Parameters:

todoId -

appConnector -

formConnector -

userId -

readOnly -

Throws:

LspsException

Method Detail

isReadOnly

public final boolean isReadOnly()

Description copied from class: LspsContextHolder

Returns true if the GUI should be opened in read-only mode.

Specified by:

isReadOnly in class LspsContextHolder

Returns:

true if in read-only mode

submit

protected RecordHolder submit()
                       throws LspsException

Description copied from class: LspsContextHolder

Submits the changes done within the context and closes the context.

Specified by:

submit in class LspsContextHolder

Returns:

navigation definition or null

Throws:

LspsException

createStackTrace

protected InterpreterStackTrace createStackTrace(String property)

submitTodo

protected abstract TodoList submitTodo()
                                throws LspsException

Throws:

LspsException

createSavedStateHolder

public RecordHolder createSavedStateHolder()

Description copied from class: LspsContextHolder

Returns a representation of the saved state in the model. This is called by UISaveAction when the save action is going to be executed.

Specified by:

createSavedStateHolder in class LspsContextHolder

Returns:

representation of the saved state in the model. Returns null if save is not supported.

save

public void save(UIScreenState uiState)
          throws LspsException

Saves the current state of the to-do.

Specified by:

save in class LspsContextHolder

Throws:

LspsException

getHistoryEntry

public RecordHolder getHistoryEntry(ExecutionContext context,
                                    Map<String,Object> defaultValues)

Returns the navigation history entry for this todo.

Parameters:

context -

defaultValues -

Returns:

navigation history entry

getTitle

public String getTitle()

Description copied from class: LspsContextHolder

Returns the title for the form content.

Specified by:

getTitle in class LspsContextHolder

Returns:

title the title or null if no content is currently loaded.

getTodo

public Todo getTodo()

Returns the displayed to-do.

Returns:

to-do

updateApplicationData

protected void updateApplicationData(ModelInstance modelInstance)

Updates the data available to the model through the getApplicationData() function.

Overrides:

updateApplicationData in class LspsContextHolder

Parameters:

modelInstance -

addSaveMetadataToUploadedBinaryData

public void addSaveMetadataToUploadedBinaryData(BinaryDataServiceLocal binaryDataService,
                                                List<Long> uploadedBinaryData)

Description copied from class: LspsContextHolder

Adds metadata to the binary data uploaded in this holder. The added metadata should provide information about document/todo in which the binary data is uploaded.

Specified by:

addSaveMetadataToUploadedBinaryData in class LspsContextHolder

isUsingEvalLevels

protected boolean isUsingEvalLevels(ExecutionContext taskContext)

getSubmitNavigationDefinition

public Variant.ClosureVariant getSubmitNavigationDefinition()

Description copied from class: LspsContextHolder

Gets the navigation definition from the document/todo definition.

Specified by:

getSubmitNavigationDefinition in class LspsContextHolder

Returns:

the navigation represented by a closure {Set<Todo> : Navigation}