de.esoco.process.step.entity

Class SelectEntity<E extends Entity>

java.lang.Object

org.obrel.core.RelatedObject

org.obrel.core.SerializableRelatedObject

de.esoco.process.ProcessElement

de.esoco.process.ProcessFragment

de.esoco.process.step.InteractionFragment

de.esoco.process.step.entity.SelectEntity<E>

All Implemented Interfaces:

de.esoco.lib.manage.Initializable, java.io.Serializable, org.obrel.core.Relatable

public class SelectEntity<E extends Entity>
extends InteractionFragment

An interactive process fragment to select an entity from a list.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static org.obrel.core.RelationType<java.util.List<org.obrel.core.RelationType<?>>>	SELECT_ENTITY_FRAGMENT A standard parameter that can be used to display this fragment in a process step.
static org.obrel.core.RelationType<Entity>	SELECTED_ENTITY The parameter containing the selected entity.

Fields inherited from class de.esoco.process.step.InteractionFragment

MESSAGE_BOX_ERROR_ICON, MESSAGE_BOX_INFO_ICON, MESSAGE_BOX_QUESTION_ICON, MESSAGE_BOX_WARNING_ICON

Fields inherited from class de.esoco.process.ProcessElement

MSG_PARAM_NOT_SET

Constructor Summary

Constructors

Constructor and Description
SelectEntity(de.esoco.storage.QueryPredicate<E> qSelectableEntities, de.esoco.lib.expression.Predicate<? super Entity> pSortOrder, java.util.List<de.esoco.lib.expression.Function<? super E,?>> rAttributes, boolean bValidateSelection) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
java.util.List<org.obrel.core.RelationType<?>>	getInputParameters() Returns the collection of input parameters of this fragment.
java.util.List<org.obrel.core.RelationType<?>>	getInteractionParameters() Returns the list of interaction parameters for this fragment.
void	handleInteraction(org.obrel.core.RelationType<?> rInteractionParam) Must be implemented by subclasses to handle interactions for this fragment.
void	init() Must be implemented to initialize the interaction parameters of this fragment.
java.util.Map<org.obrel.core.RelationType<?>,java.lang.String>	validateParameters(boolean bOnInteraction) This method can be overridden by subclasses to validate process parameters during state changes of the process.

Methods inherited from class de.esoco.process.step.InteractionFragment

abort, abortFragment, addDisplayParameters, addInputParameters, addInputParameters, addPanelParameters, addParameterUpdateListener, addSubFragment, addSubFragment, addSubFragment, addSubFragment, addViewFragment, afterInteraction, applyAllCoupledParameters, attach, button, buttons, buttons, canRollback, chart, checkBox, checkBox, checkBoxes, cleanup, clearInteractionParameters, clearSelection, comboBox, dateParam, deleteRelation, display, dropDown, dropDown, enableEdit, entityParam, entityParam, enumParam, executeCleanupActions, finish, finishFragment, flagParam, fragmentParam, get, getFragmentParameter, getParameterInteractionHandler, getParameterValidations, getParent, getProcess, getProcessStep, getRelation, getRelations, getRoot, getTemporaryParameterId, getValueDatatype, hasInteraction, icon, iconButtons, iconButtons, image, imageButtons, initComplete, initProcessStep, initQueryParameter, input, input, input, inputAttr, inputAttr, inputDate, inputTags, inputText, inputTextLines, insertInputParameters, insertInputParameters, intParam, isAttached, isInitialized, label, label, layout, listParam, lockEntityForProcess, lockEntityForStep, markFragmentInputParams, markInputParams, markParameterHierarchyAsModified, notifyParameterUpdateListeners, panel, panel, panel, panel, panel, panel, param, param, param, paramLike, prepareInteraction, prepareUpload, prepareUpload, radioButtons, reloadEntity, removeInteractionParameters, removeSubFragment, removeViewFragment, rollback, set, setContinueOnInteraction, setParam, setParameterInteractionHandler, setParameterValuesFromEntity, setParameterValuesFromEntity, setParent, setup, showConfirmationMessage, showDialog, showDialog, showDialog, showErrorMessage, showInfoMessage, showMessageBox, showMessageBox, showModalDialog, showView, showWarningMessage, structureModified, textParam, title, updateAllCoupledParameters, updateEntityFromParameterValues, updateUserInterface, validateFragmentParameters, validationError

Methods inherited from class de.esoco.process.ProcessFragment

addCleanupAction, addLayoutFiller, addPanel, addPanel, addProcessStepMessage, addSelectionDependency, addSelectionDependency, addStackPanel, addTabPanel, annotateForEntityQuery, annotateForEntityQuery, annotateParameter, applyDerivedParameter, applyDerivedParameters, applyExtraAttribute, changeDate, checkParameter, clearUIFlag, clearUIFlag, collectDerivedParameter, collectDerivedParameters, deleteParameters, disableElements, disableElements, disableElements, disableMultiSelectionElements, displayHistoryValue, enableAllElements, getAbsoluteFilePath, getAllowedElements, getAllowedValues, getCurrentQuery, getDerivedParameterValue, getFragmentId, getInputMode, getInteractiveInputParameter, getNamedTmpListType, getNamedTmpParameterType, getParameter, getParameterAnnotation, getParameterRelation, getProcessUser, getSelectionIndex, getSubFragment, getSubFragments, getTemporaryListType, getTemporaryListType, getTemporaryParameterName, getTemporaryParameterPackage, getTemporaryParameterType, getTemporaryParameterType, getTemporaryParameterType, getTemporarySetType, getUIProperties, getUIProperties, getUIProperty, getUserSetting, getUserSettings, hasFlagParameter, hasParameter, hasUIFlag, hasUserSetting, initChartParameter, initCountChartParameter, initProgressParameter, isInteractiveInput, isPanelParameter, lockEntity, markParameterAsModified, performParameterValidations, prepareDateInput, prepareDownload, prepareDownload, removeAllSubFragments, removeAllUIProperties, removeAllUIProperties, removeCleanupAction, removePanel, removeParameterAnnotation, removeSubFragment, removeTemporaryParameterType, removeUIProperties, setAllowedElements, setAllowedValues, setAllowedValues, setDatePeriod, setEnabled, setEnabled, setHtmlSize, setImmediateAction, setImmediateAction, setImmediateAction, setInteractive, setInteractive, setInteractive, setInteractive, setInteractive, setLayout, setParameter, setParameter, setParameterBounds, setProcessStepInfo, setProcessStepMessage, setProgressIndicator, setSelectionDependency, setSelectionDependency, setUIFlag, setUIFlag, setUIProperty, setUIProperty, setUIProperty, setUIProperty, setVisible, setVisible, spawnProcess, storeEntity, throwMissingParameterException, unlockEntity

Methods inherited from class de.esoco.process.ProcessElement

addDisplayParameters, continueOnInteraction, hasInteractionParameter, markInputParams, params, removeAllParameterValidations, removeInteractionParameters, removeParameterValidations, removeParameterValidations, setMandatory, setParameterNotEmptyValidations, setParameterNotEmptyValidations, setParameterNotNullValidations, setParameterNotNullValidations, setParameterValidation, setParameterValidation, staticParams

Methods inherited from class org.obrel.core.RelatedObject

notifyRelationListeners, readRelations, relationsEqual, relationsHashCode, relationsString, set, toString, transform, writeRelations

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.obrel.core.Relatable

deleteRelation, deleteRelations, getAll, getOption, getRelationCount, getRelations, hasFlag, hasRelation, hasRelations, init, set, set, set, setOption, streamRelations

Field Detail

SELECT_ENTITY_FRAGMENT

public static final org.obrel.core.RelationType<java.util.List<org.obrel.core.RelationType<?>>> SELECT_ENTITY_FRAGMENT

A standard parameter that can be used to display this fragment in a process step.

SELECTED_ENTITY

public static final org.obrel.core.RelationType<Entity> SELECTED_ENTITY

The parameter containing the selected entity.

Constructor Detail

SelectEntity

public SelectEntity(de.esoco.storage.QueryPredicate<E> qSelectableEntities,
                    de.esoco.lib.expression.Predicate<? super Entity> pSortOrder,
                    java.util.List<de.esoco.lib.expression.Function<? super E,?>> rAttributes,
                    boolean bValidateSelection)

Creates a new instance.

Parameters:

qSelectableEntities - The class of the entity type to select

pSortOrder - A predicate defining the sorting of the entities or NULL for the default order

rAttributes - The entity attributes to display

bValidateSelection - TRUE to validate that an entity has been selected; FALSE to allow no selection (i.e. a NULL value) without a validation error

Method Detail

getInputParameters

public java.util.List<org.obrel.core.RelationType<?>> getInputParameters()

Returns the collection of input parameters of this fragment. These must be a subset of InteractionFragment.getInteractionParameters(). The default implementation returns a mutable collection that can been modified directly by a subclass. Or it can be overridden by subclasses to return their own input parameter collection.

Overrides:

getInputParameters in class InteractionFragment

Returns:

The list of this fragment's input parameters

getInteractionParameters

public java.util.List<org.obrel.core.RelationType<?>> getInteractionParameters()

Returns the list of interaction parameters for this fragment. The default implementation returns a mutable list that can been modified directly by a subclass. Or it can be overridden by subclasses to return their own interaction parameter list.

Overrides:

getInteractionParameters in class InteractionFragment

Returns:

The list of this fragment's interaction parameters

handleInteraction

public void handleInteraction(org.obrel.core.RelationType<?> rInteractionParam)
                       throws java.lang.Exception

Must be implemented by subclasses to handle interactions for this fragment. The default implementation does nothing.

Overrides:

handleInteraction in class InteractionFragment

Parameters:

rInteractionParam - The interaction parameter

Throws:

java.lang.Exception - Any kind of exception may be thrown in case of errors

init

public void init()

Must be implemented to initialize the interaction parameters of this fragment.

Specified by:

init in interface de.esoco.lib.manage.Initializable

Specified by:

init in class InteractionFragment

validateParameters

public java.util.Map<org.obrel.core.RelationType<?>,java.lang.String> validateParameters(boolean bOnInteraction)

This method can be overridden by subclasses to validate process parameters during state changes of the process. The default implementation returns an new empty map instance that may be modified freely by overriding methods to add their own error messages if necessary.

Overrides:

validateParameters in class InteractionFragment

Parameters:

bOnInteraction - TRUE if the validation occurs during an ongoing interaction, FALSE after the final interaction before the fragment is finished

Returns:

A mapping from invalid parameters to validation error message (empty for none)