org.speakright.core.render
Class Prompt

java.lang.Object
  org.speakright.core.render.FormElement
      org.speakright.core.render.Prompt

All Implemented Interfaces:

java.io.Serializable

public class Prompt
extends FormElement
implements java.io.Serializable

Represents audio output (of any type). This object turns into a single voicexml prompt tag. But the prompt text of this object can contain may items, such as "Welcome {..}{ here is an ad }{ad1.wav}"

Author:

IanRaeLaptop

See Also:

Serialized Form

Nested Class Summary

static class

Prompt.PromptCondition A prompt condition controls whether a prompt plays or not.

Field Summary

java.util.ArrayList<PromptItem>

m_itemL

Constructor Summary

Prompt()

Prompt(PromptType type, java.lang.String ptext)

Prompt(PromptType type, java.lang.String ptext, int subIndex)

Prompt(java.lang.String ptext)

Method Summary

boolean	applyCondition(RenderContext rcontext)
boolean	bargeIn()
java.lang.String	ptext()
void	renderPrompts(PromptPipeline pipeline) Render any prompts in this element using the pipeline.
void	setBargeIn(boolean in)
void	setConditionCustom(boolean b)
void	setConditionNone()
void	setConditionPlayIf(java.lang.String modelVar)
void	setConditionPlayIfEmpty(java.lang.String modelVar)
void	setConditionPlayIfNotEmpty(java.lang.String modelVar)
void	setConditionPlayOnce()
void	setConditionPlayOnceEver()
void	setPText(java.lang.String ptext)
void	setSubIndex(int subIndex)
int	subIndex()
PromptType	type()

Methods inherited from class org.speakright.core.render.FormElement

renderGrammars

Methods inherited from class java.lang.Object

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

Field Detail

m_itemL

public transient java.util.ArrayList<PromptItem> m_itemL

Constructor Detail

Prompt

public Prompt()

Prompt

public Prompt(java.lang.String ptext)

Prompt

public Prompt(PromptType type,
              java.lang.String ptext)

Prompt

public Prompt(PromptType type,
              java.lang.String ptext,
              int subIndex)

Method Detail

ptext

public java.lang.String ptext()

setPText

public void setPText(java.lang.String ptext)

type

public PromptType type()

subIndex

public int subIndex()

setSubIndex

public void setSubIndex(int subIndex)

renderPrompts

public void renderPrompts(PromptPipeline pipeline)

Description copied from class: FormElement

Render any prompts in this element using the pipeline.

Overrides:

renderPrompts in class FormElement

bargeIn

public boolean bargeIn()

setBargeIn

public void setBargeIn(boolean in)

setConditionNone

public void setConditionNone()

setConditionPlayOnce

public void setConditionPlayOnce()

setConditionPlayOnceEver

public void setConditionPlayOnceEver()

setConditionPlayIf

public void setConditionPlayIf(java.lang.String modelVar)

setConditionPlayIfEmpty

public void setConditionPlayIfEmpty(java.lang.String modelVar)

setConditionPlayIfNotEmpty

public void setConditionPlayIfNotEmpty(java.lang.String modelVar)

setConditionCustom

public void setConditionCustom(boolean b)

applyCondition

public boolean applyCondition(RenderContext rcontext)