Package de.esoco.process.step

Klasse SettingsFragment

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.SettingsFragment

Alle implementierten Schnittstellen:

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

public abstract class SettingsFragment
extends InteractionFragment

A base class for fragments that edit the user settings that can be obtained through the method ProcessFragment.getUserSettings(boolean).

Siehe auch:

• Serialisierte Form

Feldübersicht

Von Klasse geerbte Felder de.esoco.process.step.InteractionFragment

MESSAGE_BOX_ERROR_ICON, MESSAGE_BOX_INFO_ICON, MESSAGE_BOX_QUESTION_ICON, MESSAGE_BOX_WARNING_ICON

Von Klasse geerbte Felder de.esoco.process.ProcessElement

MSG_PARAM_NOT_SET

Konstruktorübersicht

Konstruktoren

Konstruktor	Beschreibung
SettingsFragment()

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
void	applySettings(Entity user, Collection<org.obrel.core.RelationType<?>> settingTypes, boolean store)	Applies the edited values of certain settings by transferring them from the corresponding process parameters to the user's settings and optionally storing the settings.
void	collectSettings(Entity user, Collection<org.obrel.core.RelationType<?>> settingTypes)	Collects certain settings by transferring them from the user's settings to the corresponding process parameters.
protected <T> void	setParameterFromPreference(Configuration settings, org.obrel.core.RelationType<T> preference)	Type-safe method to set a preferences parameter from a settings configuration if it exists.
protected <T> void	setPreferenceFromParameter(Configuration settings, org.obrel.core.RelationType<T> preference)	Type-safe method to set a preferences parameter from a settings configuration.

Von Klasse geerbte Methoden 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, getInputParameters, getInteractionParameters, getParameterInteractionHandler, getParameterValidations, getParent, getProcess, getProcessStep, getRelation, getRelations, getRoot, getTemporaryParameterId, getValueDatatype, handleInteraction, hasInteraction, icon, iconButtons, iconButtons, image, imageButtons, init, 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, validateParameters, validationError

Von Klasse geerbte Methoden 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

Von Klasse geerbte Methoden de.esoco.process.ProcessElement

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

Von Klasse geerbte Methoden org.obrel.core.RelatedObject

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

Von Klasse geerbte Methoden java.lang.Object

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

Von Schnittstelle geerbte Methoden org.obrel.core.Relatable

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

Konstruktordetails

SettingsFragment

public SettingsFragment()

Methodendetails

applySettings

public void applySettings(Entity user,
 Collection<org.obrel.core.RelationType<?>> settingTypes,
 boolean store)
                   throws de.esoco.storage.StorageException,
de.esoco.lib.manage.TransactionException

Applies the edited values of certain settings by transferring them from the corresponding process parameters to the user's settings and optionally storing the settings. If no settings object exists for the user it will be created.

Parameter:

user - The user to apply the settings to

settingTypes - The settings relation types

store - TRUE to store the user settings after applying

Löst aus:

de.esoco.storage.StorageException - If updating a settings extra attribute fails

de.esoco.lib.manage.TransactionException - If creating or storing the user settings fails

collectSettings

public void collectSettings(Entity user,
 Collection<org.obrel.core.RelationType<?>> settingTypes)
                     throws de.esoco.storage.StorageException

Collects certain settings by transferring them from the user's settings to the corresponding process parameters.

Parameter:

user - The user to collect the settings from

settingTypes - The settings relation types

Löst aus:

de.esoco.storage.StorageException - If accessing a settings extra attribute fails

setParameterFromPreference

protected <T> void setParameterFromPreference(Configuration settings,
 org.obrel.core.RelationType<T> preference)
                                       throws de.esoco.storage.StorageException

Type-safe method to set a preferences parameter from a settings configuration if it exists.

Parameter:

settings - The settings (can be NULL if no settings are available)

preference - The preference extra attribute

Löst aus:

de.esoco.storage.StorageException - If reading the preference value fails

setPreferenceFromParameter

protected <T> void setPreferenceFromParameter(Configuration settings,
 org.obrel.core.RelationType<T> preference)
                                       throws de.esoco.storage.StorageException

Type-safe method to set a preferences parameter from a settings configuration.

Parameter:

settings - The settings

preference - The preference extra attribute

Löst aus:

de.esoco.storage.StorageException - If reading the preference value fails