com.whitestein.lsps.vaadin

Class AbstractDocumentHolder

java.lang.Object

com.whitestein.lsps.vaadin.LspsContextHolder

com.whitestein.lsps.vaadin.AbstractDocumentHolder

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

LspsCustomUIDocumentHolder, LspsCustomUIWithContextDocumentHolder, LspsDocumentHolder

public abstract class AbstractDocumentHolder
extends LspsContextHolder

Document holder

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected com.whitestein.lsps.human.dto.GenericDocument	document
protected String	documentId
protected Map<String,String>	parameters
protected boolean	saved
protected Long	savedDocumentId
protected UIScreenState	uiState

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

modelInstanceUtilsService, modelProviderService, sharedRecordTypeFactory

Constructor Summary

Constructors

Constructor and Description
AbstractDocumentHolder(long savedDocumentId, LspsAppConnector appConnector, LspsFormConnector formConnector, String userId) Creates context for the given saved document id.
AbstractDocumentHolder(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
void	addSaveMetadataToUploadedBinaryData(BinaryDataServiceLocal binaryDataService, List<Long> uploadedBinaryData) Adds metadata to the binary data uploaded in this holder.
protected com.whitestein.lsps.human.dto.GenericDocument	createDocumentToSave() Creates a smaller document to be saved.
protected abstract ExecutionContext	createEvaluationContext() Creates the evaluation context.
RecordHolder	createSavedStateHolder() Returns a representation of the saved state in the model.
protected abstract LspsScreen	createScreen() Creates the user interface.
com.whitestein.lsps.human.dto.GenericDocument	getDocument()
RecordHolder	getHistoryEntry(ExecutionContext context, Map<String,Object> defaultValues) Returns the navigation history entry for this document.
Variant.ClosureVariant	getSubmitNavigationDefinition() Gets the navigation definition from the document/todo definition.
String	getTitle() Returns the title for the form content.
boolean	isReadOnly() Returns true if the GUI should be opened in read-only mode.
boolean	isSaved() Returns true if the state of the GUI was already saved before opening.
void	save(UIScreenState uiState) Saves the changes done within the context.
protected abstract RecordHolder	submit() Submits the changes done within the context and closes the context.

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

Field Detail

documentId

protected String documentId

parameters

protected Map<String,String> parameters

savedDocumentId

protected Long savedDocumentId

saved

protected boolean saved

document

protected transient com.whitestein.lsps.human.dto.GenericDocument document

uiState

protected UIScreenState uiState

Constructor Detail

AbstractDocumentHolder

public AbstractDocumentHolder(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

AbstractDocumentHolder

public AbstractDocumentHolder(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 abstract ExecutionContext createEvaluationContext()
                                                     throws LspsException

Description copied from class: LspsContextHolder

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

Specified by:

createEvaluationContext in class LspsContextHolder

Returns:

evaluation context

Throws:

LspsException

createScreen

protected abstract LspsScreen createScreen()
                                    throws LspsException

Description copied from class: LspsContextHolder

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

Specified by:

createScreen in class LspsContextHolder

Returns:

user interface to be shown

Throws:

LspsException

submit

protected abstract 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

isSaved

public boolean isSaved()

Description copied from class: LspsContextHolder

Returns true if the state of the GUI was already saved before opening.

Specified by:

isSaved in class LspsContextHolder

Returns:

true if saved state is available

isReadOnly

public 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

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

Description copied from class: LspsContextHolder

Saves the changes done within the context. May not be supported by all implementations.

Specified by:

save in class LspsContextHolder

Throws:

LspsException

createDocumentToSave

protected com.whitestein.lsps.human.dto.GenericDocument createDocumentToSave()

Creates a smaller document to be saved. The copy of model instance state is garbaged collected except "document context", "ui definition" and all shared records so that the resulting state is as small as possible.

Returns:

a document that will be saved

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.

getHistoryEntry

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

Returns the navigation history entry for this document.

Parameters:

context - context in which the entry should be created

defaultValues -

Returns:

navigation history entry

getDocument

public com.whitestein.lsps.human.dto.GenericDocument getDocument()

Returns:

document definition this component is displaying

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

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}