InputAttribute class

InputAttribute is used by the state to gather input value that will be used in the state processing, or to be included with the external web service call.

Syntax

public class InputAttribute

Derived classes

Remarks

On the State Editor, InputAttribute is referred to as "Input Variable" and is represented with three UI components:

A checkbox
An "input field" (textbox or dropdown box)
An mandatory attribute indicator
A description of the input attribute
Mouse-hover showing the description, and the default session variable name

The checkbox indicates whether the value entered in the "input field" should be treated as "<i>session variable name</i>" when checked, or "<i>static value</i>" when not checked. When checked, the session variable name will be used in retrieving the value from the session variable.

In either cases, the value will always be persisted for durability across session.

Also, see OutputAttribute.

InputValue class
Helper class to return the input value and provide helper methods to convert the value into needed types.
InputAttribute(String, String, boolean) constructor
Constructor.
getInputType() method
Input type can be changed from the State Editor by checking/unchecking the input attribute checkbox, to set to InputType#SESSION or InputType#ATTRIBUTE, respectively.
getInputValue() method
More efficient way to check and obtain the value of the input attribute using a single database call.
getInputValueWithWarning() method
Similar to getInputValue() but this method throws RequiredParameterMissingException when the input attribute is not optional (or mandatory) but the value is null (or not populated).
getRawValue() method
Helper class used internally by the getInputValue(), getInputValueWithWarning(), and getValue().
getRawValueLog() method
Helper class called internally by getRawValue().
getValue() method
Get the InputValue with no warning.
isCheckboxEnabled() method
Whether the UI checkbox component is enabled or not.
isOptional() method
Whether the input attribute is optional.
isSet() method
Return True/False when the InputAttribute contains value or not, respectively.
setCheckboxEnabled(boolean) method
Enable or disable the checkbox.
setInputType(InputType) method
Input type can be changed from the State Editor by checking/unchecking the input attribute checkbox, to set it to InputType#SESSION or InputType#ATTRIBUTE, respectively.
setOptional(boolean) method
Set the input attribute optional status.
InputType() enumeration
Indicate how to treat the value provided in the input field, either as a "static value" or as a "session variable name" to retrieve the actual value from session variable using the specified name.
encrypted variable
Indicator of whether this attribute is encrypted or not.

Parent topic: controls package