de.esoco.process.param

Class ParameterBase<T,P extends ParameterBase<T,P>>

java.lang.Object

org.obrel.core.RelatedObject

de.esoco.process.param.ParameterWrapper<T,P>

de.esoco.process.param.ParameterBase<T,P>

All Implemented Interfaces:

org.obrel.core.Relatable

Direct Known Subclasses:

CollectionParameter, DataSetParameter, EntityAttributeParameter, EnumParameter, Parameter, ParameterList

public abstract class ParameterBase<T,P extends ParameterBase<T,P>>
extends ParameterWrapper<T,P>

This is a common superclass for parameter classes that wrap a process parameter relation type. It provides access to typical parameter manipulations through a fluent interface by returning the current instance from all methods. This allows to concatenated arbitrary methods in a single statement to modify the parameter properties.

By using a generic self-reference all methods in this class return an instance of the respective subclass to better support the fluent concatenation of method calls. Different subclasses may add additional methods for their specific datatype.

Constructor Summary

Constructors

Constructor and Description
ParameterBase(InteractionFragment rFragment, org.obrel.core.RelationType<T> rParamType) Creates a new instance for a certain fragment and parameter relation type.

Method Summary

Modifier and Type	Method and Description
P	actionEvents() Enables action events without setting an event handler.
P	alignHorizontal(de.esoco.lib.property.Alignment eAlignment) Sets the property LayoutProperties.HORIZONTAL_ALIGN.
P	alignIcon(de.esoco.lib.property.Alignment eAlignment) Sets the property LayoutProperties.ICON_ALIGN.
P	alignText(de.esoco.lib.property.Alignment eAlignment) Sets the property LayoutProperties.TEXT_ALIGN.
P	alignVertical(de.esoco.lib.property.Alignment eAlignment) Sets the property LayoutProperties.VERTICAL_ALIGN.
P	allEvents() Enables all events without setting an event handler.
P	allow(java.util.Collection<T> rValues) Sets the allowed values for the parameter.
P	allow(T... rValues) Sets the allowed values for the parameter.
java.util.Collection<T>	allowedValues() Returns the values that this parameter is allowed to contain.
P	allowNull(java.lang.String sNullValueItem) Allows the value NULL for a parameter that has constrained values as set with allow(Collection).
<A> P	annotate(org.obrel.core.RelationType<A> rAnnotationType, A rValue) Sets an annotation on the relation of this parameter.
P	buttons(T... rAllowedValues) Marks this parameter to be displayed as interactive buttons.
P	buttonStyle(de.esoco.lib.property.ButtonStyle eButtonStyle) Mark this parameter to be displayed with a certain button style.
boolean	check(de.esoco.lib.expression.Predicate<? super T> pValueCondition) Checks whether the value of this parameter fulfills a certain condition.
P	colSpan(int nColumns) Sets the UI property LayoutProperties.COLUMN_SPAN.
P	columns(int nColumns) Sets the UI property LayoutProperties.COLUMNS.
P	content(de.esoco.lib.property.ContentType eContentType) Sets the content type of this parameter.
P	continueOnInteraction(boolean bContinue) Sets whether the process should continue on an interaction with this parameter or not.
P	continuousEvents() Enables continuous events without setting an event handler.
P	couple(java.util.function.Consumer<T> fUpdateTarget, java.util.function.Supplier<T> fQuerySource) Couples the relation of this parameter with a certain target and/or source.
P	couple(org.obrel.core.Relatable rCoupledRelatable, org.obrel.core.RelationType<T> rCoupledType) Couples the relation of this parameter with another relation in a relatable object.
P	css(java.lang.String sCssProperty, java.lang.String sValue) Sets a CSS style property for the parameter.
P	display() Marks the wrapped relation type to be displayed as readonly in the fragment this parameter belongs to.
P	ensure(de.esoco.lib.expression.Predicate<? super T> pValueConstraint, java.lang.String sErrorMessage) Sets a general validation for this parameter.
P	ensureNotEmpty() Sets a not empty validation for this parameter.
P	height(int nHeight) Sets the pixel width of an element in the UI property LayoutProperties.WIDTH.
P	height(de.esoco.lib.property.RelativeSize eHeight) Sets the UI property LayoutProperties.RELATIVE_WIDTH.
P	height(java.lang.String sHeight) Sets the UI property LayoutProperties.HTML_HEIGHT.
P	hideLabel() Hides the label of this parameter.
P	icon(java.lang.Object rIconIdentifier) Sets the UI property ContentProperties.ICON.
P	icon(java.lang.Object rIconIdentifier, de.esoco.lib.property.Alignment eAlignment) Sets both UI properties ContentProperties.ICON and LayoutProperties.ICON_ALIGN.
P	icon(java.lang.Object rIconIdentifier, de.esoco.lib.property.RelativeScale eSize) Sets both UI properties ContentProperties.ICON and LayoutProperties.ICON_SIZE.
P	iconSize(de.esoco.lib.property.RelativeScale eSize) Sets the property LayoutProperties.ICON_SIZE.
P	images() Sets the flag property StyleProperties.HAS_IMAGES.
P	inherit(de.esoco.lib.property.PropertyName<?>... rProperties) Transfers certain properties from the parent fragment to this parameter.
P	input() Overridden to be public.
P	interactive(de.esoco.lib.property.InteractiveInputMode eInputMode) Sets the interactive input mode for this parameter.
P	interactive(de.esoco.lib.property.ListStyle eListStyle) Sets a parameter with a list of allowed values to be displayed in a certain interactive list style.
boolean	is(de.esoco.lib.property.PropertyName<java.lang.Boolean> rFlagProperty) Checks the value of a boolean property.
P	label(java.lang.String sLabel) Sets the UI property ContentProperties.LABEL.
P	layout(de.esoco.lib.property.LayoutType eLayout) Sets the layout for the panel of a parameter.
P	modified() Marks this parameter as modified.
P	notifyChangeListeners() Notifies all listeners that have been registered to listen for parameter updates with onChange(EventHandler).
P	onAction(ValueEventHandler<T> rEventHandler) Sets a simple event handler for action events of this parameter.
P	onChange(de.esoco.lib.event.EventHandler<org.obrel.core.RelationEvent<T>> rEventHandler) Registers an event handler that will be notified of changes of this parameter's relation.
P	onEvent(Interaction.InteractionHandler rEventHandler) Sets the event handler for this parameter.
P	onFocusLost(ValueEventHandler<T> rEventHandler) Sets a simple event handler for action events of this parameter.
P	onUpdate(ValueEventHandler<T> rEventHandler) Sets an event handler for update events of this parameter.
void	prepareDownload(java.lang.String sFileName, FileType eFileType, de.esoco.lib.expression.Function<FileType,?> fDownloadGenerator) Prepares a download that is associated with an event on this parameter.
P	responsiveColSpans(int nSmall, int nMedium) Sets the UI properties LayoutProperties.SMALL_COLUMN_SPAN and LayoutProperties.MEDIUM_COLUMN_SPAN.
P	rows(int nRows) Sets the UI property LayoutProperties.ROWS.
P	rowSpan(int nRows) Sets the UI property LayoutProperties.ROW_SPAN.
P	sameRow() Marks this parameter to be displayed in the same row as the previous parameter (in grid and table layouts).
P	sameRow(int nColumnSpan) Marks this parameter to be displayed in the same row as the previous parameter with a certain column span in a grid or table layout.
P	sameRow(de.esoco.lib.property.RelativeSize eColumnWidth) Marks this parameter to be displayed in the same row as the previous parameter with a certain width in a grid layout.
P	size(java.lang.String sWidth, java.lang.String sHeight) Invokes width(String) and height(String).
java.lang.String	style() Queries the UI property StyleProperties.STYLE.
P	style(java.lang.String sStyle) Sets the UI property StyleProperties.STYLE.
P	then(ParameterBase<?,?> rParameter) Appends a parameter to the row of this one.
P	tooltip(java.lang.String sTooltip) Sets the UI property ContentProperties.TOOLTIP.
java.lang.String	toString()
P	validate(de.esoco.lib.expression.Predicate<? super T> pValueConstraint, java.lang.String sErrorMessage) Validates that the value of this parameter fulfills a certain constraint.
P	validate(de.esoco.lib.expression.Predicate<? super T> pValueConstraint, java.lang.String sErrorMessage, java.lang.Runnable rRunOnViolation) Validates that the value of this parameter fulfills a certain constraint.
T	value() Returns the value of the wrapped parameter.
P	value(T rValue) Sets the parameter value.
P	width(int nWidth) Sets the pixel width of an element in the UI property LayoutProperties.WIDTH.
P	width(de.esoco.lib.property.RelativeSize eWidth) Sets the UI property LayoutProperties.RELATIVE_WIDTH.
P	width(java.lang.String sWidth) Sets the UI property LayoutProperties.HTML_WIDTH.

Methods inherited from class de.esoco.process.param.ParameterWrapper

clear, disable, enable, fragment, get, getParam, has, hide, id, initiateDownload, isEnabled, isVisible, remove, resid, set, set, set, setEnabled, setFragment, setParam, setParameterEventHandler, setParameterType, setVisible, show, type

Methods inherited from class org.obrel.core.RelatedObject

deleteRelation, get, getRelation, getRelations, notifyRelationListeners, readRelations, relationsEqual, relationsHashCode, relationsString, set, set, 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

Constructor Detail

ParameterBase

public ParameterBase(InteractionFragment rFragment,
                     org.obrel.core.RelationType<T> rParamType)

Creates a new instance for a certain fragment and parameter relation type.

If a subclass cannot provide the fragment or the relation type at creation time it may use NULL when invoking the super constructor. These values must then be set as soon as possible by invoking the respective setter method(s) (see ParameterWrapper.setFragment(InteractionFragment) and ParameterWrapper.setParameterType(RelationType)). This must happen before any other method on this instance is called or else a null pointer exception will occur. Typically this should only be used in the constructor of a subclass, e.g. to include some kind of self-reference (which is not possible while invoking the super constructor).

Parameters:

rFragment - The fragment to handle the parameter for

rParamType - The parameter relation type to handle

Method Detail

actionEvents

public final P actionEvents()

Enables action events without setting an event handler. The event handler must either be set later or the containing fragment must implement InteractionFragment.handleInteraction(RelationType).

Returns:

This instance for concatenation

alignHorizontal

public final P alignHorizontal(de.esoco.lib.property.Alignment eAlignment)

Sets the property LayoutProperties.HORIZONTAL_ALIGN.

Parameters:

eAlignment - The alignment

Returns:

This instance for concatenation

alignIcon

public final P alignIcon(de.esoco.lib.property.Alignment eAlignment)

Sets the property LayoutProperties.ICON_ALIGN.

Parameters:

eAlignment - The alignment of the icon

Returns:

This instance for concatenation

alignText

public final P alignText(de.esoco.lib.property.Alignment eAlignment)

Sets the property LayoutProperties.TEXT_ALIGN.

Parameters:

eAlignment - The alignment

Returns:

This instance for concatenation

alignVertical

public final P alignVertical(de.esoco.lib.property.Alignment eAlignment)

Sets the property LayoutProperties.VERTICAL_ALIGN.

Parameters:

eAlignment - The alignment

Returns:

This instance for concatenation

allEvents

public final P allEvents()

Enables all events without setting an event handler. The event handler must either be set later or the containing fragment must implement InteractionFragment.handleInteraction(RelationType).

Returns:

This instance for concatenation

allow

@SafeVarargs
public final P allow(T... rValues)

Sets the allowed values for the parameter.

See Also:

ProcessFragment.setAllowedValues(RelationType, Object...)

allow

public final P allow(java.util.Collection<T> rValues)

Sets the allowed values for the parameter.

See Also:

ProcessFragment.setAllowedValues(RelationType, Object...)

allowedValues

public java.util.Collection<T> allowedValues()

Returns the values that this parameter is allowed to contain.

Returns:

The allowed values (can be NULL)

allowNull

public final P allowNull(java.lang.String sNullValueItem)

Allows the value NULL for a parameter that has constrained values as set with allow(Collection). If a NULL value item string is set it will be displayed as an additional selectable value along with the allowed values. This sets the ContentProperties.NULL_VALUE.

Parameters:

sNullValueItem - The descriptive string for the NULL value item

Returns:

This instance for concatenation

annotate

public final <A> P annotate(org.obrel.core.RelationType<A> rAnnotationType,
                            A rValue)

Sets an annotation on the relation of this parameter. The relation must exist already or else a NullPointerException will occur.

Parameters:

rAnnotationType - The relation type of the annotation

rValue - The annotation value

Returns:

This instance for concatenation

buttons

@SafeVarargs
public final P buttons(T... rAllowedValues)

Marks this parameter to be displayed as interactive buttons. It's list style will be set to ListStyle.IMMEDIATE, it will have the flag StyleProperties.HIDE_LABEL set, and the property LayoutProperties.COLUMNS will be set to the number of allowed values. This will also add this parameter as an input parameter to the fragment.

Parameters:

rAllowedValues - Optionally the allowed values for this parameter (NULL or empty for the default)

Returns:

This instance for concatenation

buttonStyle

public final P buttonStyle(de.esoco.lib.property.ButtonStyle eButtonStyle)

Mark this parameter to be displayed with a certain button style.

Parameters:

eButtonStyle - The button style

Returns:

This instance for concatenation

See Also:

buttons(Object...)

check

public boolean check(de.esoco.lib.expression.Predicate<? super T> pValueCondition)

Checks whether the value of this parameter fulfills a certain condition.

Parameters:

pValueCondition - The predicate that checks the condition

Returns:

TRUE if the condition is fulfilled

colSpan

public final P colSpan(int nColumns)

Sets the UI property LayoutProperties.COLUMN_SPAN.

Parameters:

nColumns - the number of columns to span.

Returns:

This instance for concatenation

columns

public final P columns(int nColumns)

Sets the UI property LayoutProperties.COLUMNS.

Parameters:

nColumns - the number of columns.

Returns:

This instance for concatenation

content

public final P content(de.esoco.lib.property.ContentType eContentType)

Sets the content type of this parameter.

Parameters:

eContentType - The content type

Returns:

This instance for concatenation

continueOnInteraction

public final P continueOnInteraction(boolean bContinue)

Sets whether the process should continue on an interaction with this parameter or not. If an application needs to change this state during an interaction it should first be set to TRUE so that the (final) process step validations that are performed on transitions to another step work correctly.

Parameters:

bContinue - TRUE to continue process execution, FALSE to stay in the current step and wait for further interactions

Returns:

This instance for concatenation

continuousEvents

public final P continuousEvents()

Enables continuous events without setting an event handler. The event handler must either be set later or the containing fragment must implement InteractionFragment.handleInteraction(RelationType).

Returns:

This instance for concatenation

couple

public P couple(java.util.function.Consumer<T> fUpdateTarget,
                java.util.function.Supplier<T> fQuerySource)

Couples the relation of this parameter with a certain target and/or source.

Returns:

This instance for concatenation

See Also:

RelationCoupling.couple(org.obrel.core.Relatable, RelationType, Consumer, Supplier)

couple

public P couple(org.obrel.core.Relatable rCoupledRelatable,
                org.obrel.core.RelationType<T> rCoupledType)

Couples the relation of this parameter with another relation in a relatable object.

Parameters:

rCoupledRelatable - The coupled relatable

rCoupledType - The relation type to couple this parameter with

Returns:

This instance for concatenation

css

public final P css(java.lang.String sCssProperty,
                   java.lang.String sValue)

Sets a CSS style property for the parameter.

Parameters:

sCssProperty - The name of the CSS property

sValue - The value of the CSS property or NULL to clear

Returns:

This instance for concatenation

display

public P display()

Marks the wrapped relation type to be displayed as readonly in the fragment this parameter belongs to.

Returns:

This instance for concatenation

ensure

public P ensure(de.esoco.lib.expression.Predicate<? super T> pValueConstraint,
                java.lang.String sErrorMessage)

Sets a general validation for this parameter.

Parameters:

pValueConstraint - The constraint that must be valid

sErrorMessage - The error message to be displayed for the parameter in the case of a constraint violation

Returns:

This instance for concatenation

ensureNotEmpty

public P ensureNotEmpty()

Sets a not empty validation for this parameter.

Returns:

This instance for concatenation

height

public final P height(int nHeight)

Sets the pixel width of an element in the UI property LayoutProperties.WIDTH.

Parameters:

nHeight - nWidth The width

Returns:

This instance for concatenation

height

public final P height(de.esoco.lib.property.RelativeSize eHeight)

Sets the UI property LayoutProperties.RELATIVE_WIDTH.

Parameters:

eHeight - sWidth The relative width constant

Returns:

This instance for concatenation

height

public final P height(java.lang.String sHeight)

Sets the UI property LayoutProperties.HTML_HEIGHT.

Parameters:

sHeight - The HTML height string

Returns:

This instance for concatenation

hideLabel

public final P hideLabel()

Hides the label of this parameter.

Returns:

This instance for concatenation

icon

public final P icon(java.lang.Object rIconIdentifier)

Sets the UI property ContentProperties.ICON.

Parameters:

rIconIdentifier - An identifier that describes the icon to display; will be converted to a string and should typically either be a string of an enum constant

Returns:

This instance for concatenation

icon

public final P icon(java.lang.Object rIconIdentifier,
                    de.esoco.lib.property.RelativeScale eSize)

Sets both UI properties ContentProperties.ICON and LayoutProperties.ICON_SIZE.

Parameters:

rIconIdentifier - The icon identifier (icon(Object))

eSize - The relative size of the icon

Returns:

This instance for concatenation

icon

public final P icon(java.lang.Object rIconIdentifier,
                    de.esoco.lib.property.Alignment eAlignment)

Sets both UI properties ContentProperties.ICON and LayoutProperties.ICON_ALIGN. Not all types of Alignment may be supported in an UI implementation.

Parameters:

rIconIdentifier - The icon identifier (icon(Object))

eAlignment - The position alignment of the icon

Returns:

This instance for concatenation

iconSize

public final P iconSize(de.esoco.lib.property.RelativeScale eSize)

Sets the property LayoutProperties.ICON_SIZE.

Parameters:

eSize - The relative size of the icon

Returns:

This instance for concatenation

images

public final P images()

Sets the flag property StyleProperties.HAS_IMAGES.

Returns:

This instance for concatenation

inherit

public final P inherit(de.esoco.lib.property.PropertyName<?>... rProperties)

Transfers certain properties from the parent fragment to this parameter.

Parameters:

rProperties - The properties to transfer

Returns:

This instance for concatenation

input

public P input()

Overridden to be public.

Returns:

This instance for concatenation

See Also:

ParameterWrapper.input()

interactive

public final P interactive(de.esoco.lib.property.InteractiveInputMode eInputMode)

Sets the interactive input mode for this parameter.

Parameters:

eInputMode - The interactive input mode

Returns:

This instance for concatenation

interactive

public final P interactive(de.esoco.lib.property.ListStyle eListStyle)

Sets a parameter with a list of allowed values to be displayed in a certain interactive list style.

Parameters:

eListStyle - The style in which to display the allowed values

Returns:

This instance for concatenation

is

public final boolean is(de.esoco.lib.property.PropertyName<java.lang.Boolean> rFlagProperty)

Checks the value of a boolean property.

See Also:

ParameterWrapper.get(PropertyName)

label

public final P label(java.lang.String sLabel)

Sets the UI property ContentProperties.LABEL.

Parameters:

sLabel - sWidth The label string

Returns:

This instance for concatenation

layout

public P layout(de.esoco.lib.property.LayoutType eLayout)

Sets the layout for the panel of a parameter. This will only be valid if the given parameter is rendered in a panel (like DataElementList or buttons).

Parameters:

eLayout - The panel layout

Returns:

This instance for concatenation

modified

public final P modified()

Marks this parameter as modified.

Returns:

This instance for concatenation

notifyChangeListeners

public final P notifyChangeListeners()

Notifies all listeners that have been registered to listen for parameter updates with onChange(EventHandler).

Returns:

This instance for concatenation

onAction

public final P onAction(ValueEventHandler<T> rEventHandler)

Sets a simple event handler for action events of this parameter.

Parameters:

rEventHandler - The event handler to be invoked on an event

Returns:

This instance for concatenation

onChange

public final P onChange(de.esoco.lib.event.EventHandler<org.obrel.core.RelationEvent<T>> rEventHandler)

Registers an event handler that will be notified of changes of this parameter's relation.

Parameters:

rEventHandler - The event handler to register

Returns:

This instance for concatenation

See Also:

Relation.addUpdateListener(EventHandler)

onEvent

public final P onEvent(Interaction.InteractionHandler rEventHandler)

Sets the event handler for this parameter. The handler will only be invoked if events have been enabled for this parameter with one of the corresponding methods.

Parameters:

rEventHandler - The event handler to register

Returns:

This instance for concatenation

See Also:

interactive(InteractiveInputMode), interactive(ListStyle), continuousEvents(), actionEvents(), allEvents()

onFocusLost

public final P onFocusLost(ValueEventHandler<T> rEventHandler)

Sets a simple event handler for action events of this parameter.

Parameters:

rEventHandler - The event handler to be invoked on an event

Returns:

This instance for concatenation

onUpdate

public final P onUpdate(ValueEventHandler<T> rEventHandler)

Sets an event handler for update events of this parameter.

Parameters:

rEventHandler - The event handler to be invoked on an event

Returns:

This instance for concatenation

prepareDownload

public void prepareDownload(java.lang.String sFileName,
                            FileType eFileType,
                            de.esoco.lib.expression.Function<FileType,?> fDownloadGenerator)

Prepares a download that is associated with an event on this parameter. This method must be invoked during the handling of the event and the download will then be executed as the result of the event. After being processed by the process interaction the generated download URL will be removed from the parameter.

Parameters:

sFileName - The file name of the download

eFileType - The file type of the download

fDownloadGenerator - The function that generates the download data

Throws:

java.lang.Exception - If the download preparation fails

responsiveColSpans

public final P responsiveColSpans(int nSmall,
                                  int nMedium)

Sets the UI properties LayoutProperties.SMALL_COLUMN_SPAN and LayoutProperties.MEDIUM_COLUMN_SPAN.

Parameters:

nSmall - the number of columns to span in small-size layouts

nMedium - the number of columns to span in medium-size layouts

Returns:

This instance for concatenation

rows

public final P rows(int nRows)

Sets the UI property LayoutProperties.ROWS.

Parameters:

nRows - the number of rows.

Returns:

This instance for concatenation

rowSpan

public final P rowSpan(int nRows)

Sets the UI property LayoutProperties.ROW_SPAN.

Parameters:

nRows - the number of rows to span.

Returns:

This instance for concatenation

sameRow

public final P sameRow()

Marks this parameter to be displayed in the same row as the previous parameter (in grid and table layouts).

Returns:

This instance for concatenation

sameRow

public final P sameRow(int nColumnSpan)

Marks this parameter to be displayed in the same row as the previous parameter with a certain column span in a grid or table layout.

Parameters:

nColumnSpan - The number of columns that the parameter UI should span

Returns:

This instance for concatenation

sameRow

public final P sameRow(de.esoco.lib.property.RelativeSize eColumnWidth)

Marks this parameter to be displayed in the same row as the previous parameter with a certain width in a grid layout.

Parameters:

eColumnWidth - The relative width of the parameter UI in a grid layout

Returns:

This instance for concatenation

size

public final P size(java.lang.String sWidth,
                    java.lang.String sHeight)

Invokes width(String) and height(String).

Parameters:

sWidth - The HTML width string

sHeight - The HTML height string

Returns:

This instance for concatenation

style

public final java.lang.String style()

Queries the UI property StyleProperties.STYLE.

Returns:

The style name (NULL for none)

style

public final P style(java.lang.String sStyle)

Sets the UI property StyleProperties.STYLE.

Parameters:

sStyle - The style name(s)

Returns:

This instance for concatenation

then

public P then(ParameterBase<?,?> rParameter)

Appends a parameter to the row of this one. This is the same as invoking the method sameRow() on the argument parameter.

Parameters:

rParameter - The parameter to add to the current row

Returns:

This instance for concatenation

tooltip

public final P tooltip(java.lang.String sTooltip)

Sets the UI property ContentProperties.TOOLTIP.

Parameters:

sTooltip - sWidth The tooltip string

Returns:

This instance for concatenation

toString

public java.lang.String toString()

Overrides:

toString in class org.obrel.core.RelatedObject

validate

public P validate(de.esoco.lib.expression.Predicate<? super T> pValueConstraint,
                  java.lang.String sErrorMessage)
           throws InvalidParametersException

Validates that the value of this parameter fulfills a certain constraint. If not an exception will be thrown.

Parameters:

pValueConstraint - The constraint to be validated

sErrorMessage - The error message to be displayed for the parameter in the case of a constraint violation

Returns:

This instance for concatenation

Throws:

InvalidParametersException - If the constraint is violated

validate

public P validate(de.esoco.lib.expression.Predicate<? super T> pValueConstraint,
                  java.lang.String sErrorMessage,
                  java.lang.Runnable rRunOnViolation)
           throws InvalidParametersException

Validates that the value of this parameter fulfills a certain constraint. If not an exception will be thrown.

Parameters:

pValueConstraint - The constraint to be validated

sErrorMessage - The error message to be displayed for the parameter in the case of a constraint violation

rRunOnViolation - A runnable to be executed if the constraint is violated

Returns:

This instance for concatenation

Throws:

InvalidParametersException - If the constraint is violated

value

public final T value()

Returns the value of the wrapped parameter.

See Also:

ProcessFragment.getParameter(RelationType)

value

public final P value(T rValue)

Sets the parameter value.

See Also:

ProcessFragment.setParameter(RelationType, Object)

width

public final P width(java.lang.String sWidth)

Sets the UI property LayoutProperties.HTML_WIDTH.

Parameters:

sWidth - The HTML width string

Returns:

This instance for concatenation

width

public final P width(de.esoco.lib.property.RelativeSize eWidth)

Sets the UI property LayoutProperties.RELATIVE_WIDTH.

Parameters:

eWidth - The relative width constant

Returns:

This instance for concatenation

width

public final P width(int nWidth)

Sets the pixel width of an element in the UI property LayoutProperties.WIDTH.

Parameters:

nWidth - The width

Returns:

This instance for concatenation