SessionVariableAttribute class

This is a special type of Attribute that does not have the UI component on the State Editor.

Syntax

public class SessionVariableAttribute

Base class/Interfaces

Members

All public members of the SessionVariableAttribute class, including all inherited members.

Name	Description
Attribute constructor	Default value (if provided)
SessionVariableAttribute constructor
getDescription method	Detailed description of the attribute.
getId method	Attribute Id.
getText method	The text that was entered in the input field on the state editor.
setContext method	Sets the processing engine context.
setDescription method	Detailed description of the attribute.
setId method	Attribute Id.

All package members of the SessionVariableAttribute class, including all inherited members.

Name	Description
getList method	Get the complete List of BeanConverterInterface type from the session variable.
setList method	Set the List that needs to be stored in this SessionVariableAttribute.

All protected members of the SessionVariableAttribute class, including all inherited members.

Name	Description
getContext method	Sets the processing engine context.
description variable	Description that will be displayed on the state editor for user consumption.
id variable	Unique Id of the attribute.

Remarks

SessionVariableAttribute is used to hold and persist List of BeanConverterInterface type.

Each item in the list is stored in one session variable using the following naming convention for the session variable name.

       this_sessionVariableAttribute_ID + "_" + state_ID + "[" + index + "]"

where: index is the list index.

In addition, one session variable with the following name is used to store the total number of item in the list.

		this_sessionVariableAttribute_ID + "_" + state_ID + "_count"

SessionVariableAttribute is used in the AbstractDynamicMenu to store the list in the input parameter of the setMenuListToSession(List<T>) method. This list is used to generate SMS menu message.

SessionVariableAttribute constructor
getList method
setList method

Discuss this page in DocCommentXchange.