org.jvoicexml.interpreter

Interface PromptCountable

All Known Subinterfaces:

GrammarContainer, InputItem

All Known Implementing Classes:

FieldFormItem, InitialFormItem, ObjectFormItem, RecordFormItem, SubdialogFormItem, TransferFormItem

public interface PromptCountable

Tapered prompts are those that may change with each attempt. Information-requesting prompts may become more terse under the assumption that the user is becoming more familiar with the task. Help messages become more detailed perhaps, under the assumption that the user needs more help. Or, prompts can change just to make the interaction more interesting. Each input item, <initial>, and menu has an internal prompt counter that is reset to one each time the form or menu is entered. Whenever the system selects a given input item in the select phase of FIA and FIA does perform normal selection and queuing of prompts, the input item's associated prompt counter is incremented. This is the mechanism supporting tapered prompts.

Since:

0.3.1

Method Summary

Modifier and Type	Method and Description
java.lang.String	getName() Retrieves the name.
org.jvoicexml.xml.VoiceXmlNode	getNode() Retrieves the corresponding node in the VoiceXML document.
int	getPromptCount() Retrieves the value of the prompt counter.
void	incrementPromptCount() Increments the prompt counter.
void	resetPromptCount() Resets the prompt counter.

Method Detail

getName

java.lang.String getName()

Retrieves the name.

Returns:

Name of the countable.

getNode

org.jvoicexml.xml.VoiceXmlNode getNode()

Retrieves the corresponding node in the VoiceXML document.

Returns:

Corresponding node in the VoiceXML document.

getPromptCount

int getPromptCount()

Retrieves the value of the prompt counter.

Returns:

Value of the prompt counter.

incrementPromptCount

void incrementPromptCount()

Increments the prompt counter.

resetPromptCount

void resetPromptCount()

Resets the prompt counter.