org.jvoicexml.interpreter.dialog

Class ConvertedChoiceOption

java.lang.Object

org.jvoicexml.interpreter.dialog.ConvertedChoiceOption

All Implemented Interfaces:

java.lang.Cloneable

public final class ConvertedChoiceOption
extends java.lang.Object
implements java.lang.Cloneable

A converted choice option. The core attributes are the accepted inputs and the grammar. Accepted inputs are used to create the <if> conditions. A grammar node can be used to bypass the generation of a SRGS XML grammar from the accepted inputs. If at least one ConvertedChoiceOption contains a grammar node, no SRGS grammar will be generated. The created grammar is appended as a child node to the generated anonymous field by calling setGrammar(Grammar).

Since:

0.7.5

Constructor Summary

Constructors

Constructor and Description
ConvertedChoiceOption(org.jvoicexml.xml.vxml.Field fld) Constructs a new object.

Method Summary

Modifier and Type	Method and Description
void	addAcceptedInput(java.lang.String input) Adds the given input to the list of accepted inputs.
protected ConvertedChoiceOption	clone()
org.jvoicexml.xml.srgs.Grammar	createGrammarNode() Creates an empty grammar node within the field.
org.jvoicexml.xml.vxml.AcceptType	getAccept() Retrieves the accept type.
java.util.Collection<java.lang.String>	getAcceptedInputs() Retrieves the accepted inputs.
java.lang.String	getDtmf() Retrieves the DTMF sequence of a choice node.
JVoiceXMLEvent	getEvent() Retrieves the event to be thrwon instead of a next.
org.jvoicexml.xml.srgs.Grammar	getGrammar() Retrieves the grammar object.
org.jvoicexml.xml.srgs.ModeType	getMode() Sets the mode type.
java.net.URI	getNext() Retrieves the URI of next dialog or document.
java.lang.String	getText() Retrieves the text within the choice node.
void	setAccept(org.jvoicexml.xml.vxml.AcceptType acceptType) Sets the accept type.
void	setAcceptedInputs(java.util.Collection<java.lang.String> inputs) Set the accepted inputs of the grammar.
void	setDtmf(java.lang.String value) Sets the DTMF sequence that is set in the choice node.
void	setEvent(JVoiceXMLEvent e) Sets the event to be thrown instead of a next.
void	setGrammar(org.jvoicexml.xml.srgs.Grammar gram) Sets the grammar object.
void	setMode(org.jvoicexml.xml.srgs.ModeType modeType) Retrieves the mode type.
void	setNext(java.net.URI uri) Sets the URI of next dialog or document.
void	setText(java.lang.String txt) Sets the text that is contained in the choice node.

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ConvertedChoiceOption

public ConvertedChoiceOption(org.jvoicexml.xml.vxml.Field fld)

Constructs a new object.

Parameters:

fld - the created field

Method Detail

getMode

public org.jvoicexml.xml.srgs.ModeType getMode()

Sets the mode type.

Returns:

the mode

setMode

public void setMode(org.jvoicexml.xml.srgs.ModeType modeType)

Retrieves the mode type.

Parameters:

modeType - the mode to set

getAcceptedInputs

public java.util.Collection<java.lang.String> getAcceptedInputs()

Retrieves the accepted inputs.

Returns:

the acceptedInputs

setAcceptedInputs

public void setAcceptedInputs(java.util.Collection<java.lang.String> inputs)

Set the accepted inputs of the grammar.

Parameters:

inputs - the acceptedInputs to set

addAcceptedInput

public void addAcceptedInput(java.lang.String input)

Adds the given input to the list of accepted inputs.

Parameters:

input - the input to accept

getAccept

public org.jvoicexml.xml.vxml.AcceptType getAccept()

Retrieves the accept type.

Returns:

the accept

setAccept

public void setAccept(org.jvoicexml.xml.vxml.AcceptType acceptType)

Sets the accept type.

Parameters:

acceptType - the accept to set

getGrammar

public org.jvoicexml.xml.srgs.Grammar getGrammar()

Retrieves the grammar object.

Returns:

the grammar

setGrammar

public void setGrammar(org.jvoicexml.xml.srgs.Grammar gram)

Sets the grammar object.

Parameters:

gram - the grammar to set

createGrammarNode

public org.jvoicexml.xml.srgs.Grammar createGrammarNode()

Creates an empty grammar node within the field.

Returns:

the created grammar node

Since:

0.7.5

getNext

public java.net.URI getNext()

Retrieves the URI of next dialog or document.

Returns:

the next

setNext

public void setNext(java.net.URI uri)

Sets the URI of next dialog or document.

Parameters:

uri - the next to set

getEvent

public JVoiceXMLEvent getEvent()

Retrieves the event to be thrwon instead of a next.

Returns:

the event

setEvent

public void setEvent(JVoiceXMLEvent e)

Sets the event to be thrown instead of a next.

Parameters:

e - the event to set

getText

public java.lang.String getText()

Retrieves the text within the choice node.

Returns:

the text

setText

public void setText(java.lang.String txt)

Sets the text that is contained in the choice node.

Parameters:

txt - the text to set

getDtmf

public java.lang.String getDtmf()

Retrieves the DTMF sequence of a choice node.

Returns:

the DTMF sequence

setDtmf

public void setDtmf(java.lang.String value)

Sets the DTMF sequence that is set in the choice node.

Parameters:

value - the DTMF sequence to set

clone

protected ConvertedChoiceOption clone()

Overrides:

clone in class java.lang.Object