org.jvoicexml.interpreter

Interface FormItem

All Superinterfaces:

DialogConstruct, FormItemVisitable

All Known Subinterfaces:

CatchContainer, ControlItem, GrammarContainer, InputItem

All Known Implementing Classes:

BlockFormItem, FieldFormItem, InitialFormItem, ObjectFormItem, RecordFormItem, SubdialogFormItem, TransferFormItem

public interface FormItem
extends FormItemVisitable, DialogConstruct

Form items are the elements that can be visited in the main loop of the form interpretation algorithm. Input items direct the FIA to gather a result for a specific element. When the FIA selects a control item, the control item may contain a block of procedural code to execute, or it may tell the FIA to set up the initial prompt-and-collect for a mixed initiative form.

Since:

0.4

See Also:

FormInterpretationAlgorithm

Method Summary

Modifier and Type	Method and Description
boolean	evaluateCondition() An expression to evaluate in conjunction with the test of the form item variable.
java.lang.Object	evaluateExpression(DataModel model) Retrieves the evaluated expr attribute.
java.lang.Object	getFormItemVariable() Retrieves the form item variable.
java.lang.String	getName() Retrieves the name of this FormItem..
org.jvoicexml.xml.VoiceXmlNode	getNode() Retrieves the encapsulated VoiceXmlNode.
java.lang.String	getNodeTagName() Retrieves the tag name of the encapsulated node.
void	init(DataModel model) Initializes this form item.
boolean	isModal() Checks if this form item is modal.
boolean	isSelectable() Guard conditions, which governs whether or not this form item can be selected by the form interpretation algorithm.
int	setFormItemVariable(java.lang.Object value) Sets the value of the form item variable.

Methods inherited from interface org.jvoicexml.interpreter.FormItemVisitable

accept

Method Detail

init

void init(DataModel model)
   throws SemanticError,
          BadFetchError

Initializes this form item.

Parameters:

model - the employed data model

Throws:

SemanticError - error initializing this form item

BadFetchError - error initializing this form item

Since:

0.7.3

getFormItemVariable

java.lang.Object getFormItemVariable()

Retrieves the form item variable.

Each form has an associated form item variable. which by default is set to null when the form is entered. This form item variable will contain the result of interpreting the form item. An input item's form variable can be given a name using the name attribute or left nameless in which case an internal name is generated.

Returns:

result of interpreting this form item.

setFormItemVariable

int setFormItemVariable(java.lang.Object value)
                 throws SemanticError

Sets the value of the form item variable.

Parameters:

value - new value for the form item variable.

Returns:

0 if setting the form item variable was successful

Throws:

SemanticError - error setting the value

getName

java.lang.String getName()

Retrieves the name of this FormItem..

Returns:

Name of a dialog scoped form item variable.

isSelectable

boolean isSelectable()
              throws SemanticError

Guard conditions, which governs whether or not this form item can be selected by the form interpretation algorithm.

This default guard condition just tests to see if the form item variable has a value. If it does, this form item will not be visited.

Returns:

true if the form item's variable has no value.

Throws:

SemanticError - error evaluating the cond condition.

See Also:

getFormItemVariable()

getNode

org.jvoicexml.xml.VoiceXmlNode getNode()

Retrieves the encapsulated VoiceXmlNode.

Returns:

Related VoiceXmlNode.

getNodeTagName

java.lang.String getNodeTagName()

Retrieves the tag name of the encapsulated node.

Returns:

tag name of the encapsulated node.

Since:

0.7

evaluateExpression

java.lang.Object evaluateExpression(DataModel model)
                             throws SemanticError

Retrieves the evaluated expr attribute.

Parameters:

model - the data model to use for evaluation

Returns:

evaluated expression of the expr attribute.

Throws:

SemanticError - error evaluating the expr attribute.

evaluateCondition

boolean evaluateCondition()
                   throws SemanticError

An expression to evaluate in conjunction with the test of the form item variable. If absent, this defaults to true, or in the case of <initial>, a test to see if any input item variable has been filled in.

Returns:

true if the cond attribute of the form item evaluates to true.

Throws:

SemanticError - error evaluating the cond attribute.

isModal

boolean isModal()

Checks if this form item is modal. This causes all grammars to be disabled except the ones defined in the current form item.

Returns:

true if the form item is modal.

Since:

0.7.2