com.whitestein.lsps.vaadin

Class LspsDocumentHolder

java.lang.Object

com.whitestein.lsps.vaadin.LspsContextHolder

com.whitestein.lsps.vaadin.AbstractDocumentHolder

com.whitestein.lsps.vaadin.LspsDocumentHolder

All Implemented Interfaces:

Serializable

public class LspsDocumentHolder
extends AbstractDocumentHolder

Extension of LspsContextHolder which displays and handles the lifecycle of a LSPS document.

Author:

mbj

See Also:

Serialized Form

Field Summary

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

document, documentId, parameters, saved, savedDocumentId, uiState

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

modelInstanceUtilsService, modelProviderService, sharedRecordTypeFactory

Constructor Summary

Constructors

Constructor and Description
LspsDocumentHolder(long savedDocumentId, LspsAppConnector appConnector, LspsFormConnector formConnector, String userId) Creates context for the given saved document id.
LspsDocumentHolder(String documentId, Map<String,String> parameters, LspsAppConnector appConnector, LspsFormConnector formConnector, String userId) Creates context for the given document id with the given parameters.

Method Summary

Modifier and Type	Method and Description
protected ExecutionContext	createEvaluationContext() Creates the evaluation context.
protected LspsScreen	createScreen() Creates the user interface.
Map<String,String>	getParameters() Returns parameters of document.
protected RecordHolder	submit() Submits the changes done within the context and closes the context.

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

addSaveMetadataToUploadedBinaryData, createDocumentToSave, createSavedStateHolder, getDocument, getHistoryEntry, getSubmitNavigationDefinition, getTitle, isReadOnly, isSaved, save

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

LspsDocumentHolder

public LspsDocumentHolder(long savedDocumentId,
                          LspsAppConnector appConnector,
                          LspsFormConnector formConnector,
                          String userId)
                   throws LspsException

Creates context for the given saved document id.

Parameters:

savedDocumentId -

appConnector -

formConnector -

userId -

Throws:

LspsException

LspsDocumentHolder

public LspsDocumentHolder(String documentId,
                          Map<String,String> parameters,
                          LspsAppConnector appConnector,
                          LspsFormConnector formConnector,
                          String userId)
                   throws LspsException

Creates context for the given document id with the given parameters.

Parameters:

documentId -

parameters -

appConnector -

formConnector -

userId -

Throws:

LspsException

Method Detail

createEvaluationContext

protected ExecutionContext createEvaluationContext()
                                            throws LspsException

Description copied from class: LspsContextHolder

Creates the evaluation context. Called from LspsContextHolder.reloadContent().

Specified by:

createEvaluationContext in class AbstractDocumentHolder

Returns:

evaluation context

Throws:

LspsException

createScreen

protected LspsScreen createScreen()
                           throws LspsException

Description copied from class: LspsContextHolder

Creates the user interface. Called from LspsContextHolder.reloadContent().

Specified by:

createScreen in class AbstractDocumentHolder

Returns:

user interface to be shown

Throws:

LspsException

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 AbstractDocumentHolder

Returns:

navigation definition or null

Throws:

LspsException

getParameters

public Map<String,String> getParameters()

Returns parameters of document.

Returns:

parameters of document