Uses of Interface
org.speakright.core.IFlow

Packages that use IFlow

org.speakright.core
org.speakright.core.flows
org.speakright.core.render
org.speakright.core.tests
org.speakright.demos.simpsons
org.speakright.itest
org.speakright.servlet
org.speakright.sro
org.speakright.sro.gen
org.speakright.sro.tests

Uses of IFlow in org.speakright.core

Subinterfaces of IFlow in org.speakright.core

interface

IConfirmationFlow A flow that does confirmation (of a previous question).

Classes in org.speakright.core that implement IFlow

class	AppEvent An application event is is a custom event that an application can "throw" in order to transfer control to another active flow object.
class	ConfirmationWrapper Implements confirmation in an extensible way.
class	ControlFlow Base class for all "events" in SpeakRight.
class	ExitEvent ExitEvent terminates execution immediately.
class	FlowBase FlowBase is an adapter for IFlow; it implements all the IFlow interface methods.
class	ThrowEvent "Throws" an event.
class	TrailWrapper A wrapper flow object that does nothing except remember which of its methods were called.

Fields in org.speakright.core declared as IFlow

IFlow	ExecutionContext.m_flow
IFlow	ModelBindingSpec.m_flow

Methods in org.speakright.core that return IFlow

IFlow	SRInstance.ApplicationFlow() Get the outermost flow object, that was passed to start.
IFlow	SRRunner.ApplicationFlow() Get the outermost flow object, that was passed to start.
IFlow	ConfirmationWrapper.doQuestionGetNext(IFlow current, SRResults results)
IFlow	FlowBase.getFirst(IFlowContext context) The default implementation of getFirst is to return this.
IFlow	ConfirmationWrapper.getFirst(IFlowContext context) start with the question.
IFlow	IFlow.getFirst(IFlowContext context) Gets the first sub-flow to be executed.
IFlow	TrailWrapper.getFirst(IFlowContext context)
IFlow	FlowBase.getNext(IFlow current, SRResults results) The default implementation of getNext is to return null.
IFlow	ConfirmationWrapper.getNext(IFlow current, SRResults results) Apply the confirmation based on the state.
IFlow	IFlow.getNext(IFlow current, SRResults results) Gets the next flow object to be executed.
IFlow	TrailWrapper.getNext(IFlow current, SRResults results)
IFlow	FlowBase.getSubFlowAfter(IFlow subFlow)
IFlow	IFlow.getSubFlowAfter(IFlow subFlow) Return the next sub-flow after subFlow.
IFlow	TrailWrapper.getSubFlowAfter(IFlow subFlow)
IFlow	TrailWrapper.InnerFlow()
IFlow	FlowBase.onCatch(IFlow current, SRResults results, java.lang.String eventName, ThrowEvent event) The default implementation of onCatch is to return null, indicating that this object does not handle custom events.
IFlow	IFlow.onCatch(IFlow current, SRResults results, java.lang.String eventName, ThrowEvent event) Event handler for custom events.
IFlow	TrailWrapper.onCatch(IFlow current, SRResults results, java.lang.String eventName, ThrowEvent event)
IFlow	FlowBase.onDisconnect(IFlow current, SRResults results) The default implementation of onDisconnect is to return null, indicating that this object does not handle disconnect events.
IFlow	IFlow.onDisconnect(IFlow current, SRResults results) Event handler for a disconnect event.
IFlow	TrailWrapper.onDisconnect(IFlow current, SRResults results)
IFlow	FlowBase.onNoInput(IFlow current, SRResults results) The default implementation of onNoInput is to return null, indicating that this object does not handle no-input events.
IFlow	IFlow.onNoInput(IFlow current, SRResults results) Event handler for the no-input event.
IFlow	TrailWrapper.onNoInput(IFlow current, SRResults results)
IFlow	FlowBase.onPlatformError(IFlow current, SRResults results) The default implementation of onCatch is to return null, indicating that this object does not handle platform errors.
IFlow	IFlow.onPlatformError(IFlow current, SRResults results) Event handler for a error returned by the speech platform.
IFlow	TrailWrapper.onPlatformError(IFlow current, SRResults results)
IFlow	FlowBase.onTransferFailed(IFlow current, SRResults results) The default implementation of onCatch is to return null, indicating that this object does not handle transfer failures.
IFlow	IFlow.onTransferFailed(IFlow current, SRResults results) Event handler for a failed transfer.
IFlow	TrailWrapper.onTransferFailed(IFlow current, SRResults results)
IFlow	FlowBase.onValidateFailed(IFlow current, SRResults results) The default implementation of onValidateFailed is to return null, indicating that this object does not handle validate-failed events.
IFlow	IFlow.onValidateFailed(IFlow current, SRResults results) Event handler for validation failed.
IFlow	TrailWrapper.onValidateFailed(IFlow current, SRResults results)
IFlow	SRInstance.peekCurrent() Get the currently executing flow object.

Methods in org.speakright.core with parameters of type IFlow

void	PlayOnceTracker.add(IFlow flow, java.lang.String text)
void	PlayOnceTracker.add(IFlow flow, java.lang.String text, boolean onceEver)
void	IModelBinder.addBinding(IFlow flow, java.lang.String slotName, java.lang.String modelVar) Bind the given slot to a model variable.
void	ModelBinder.addBinding(IFlow flow, java.lang.String slotName, java.lang.String propName) adds a binding.
void	IModelBinder.bind(IFlow current, SRResults results) Inspect the results and bind any model variables that are bound to slot values in the results.
void	ModelBinder.bind(IFlow current, SRResults results) Looks for and applies any data binding.
IFlow	ConfirmationWrapper.doQuestionGetNext(IFlow current, SRResults results)
org.speakright.core.PlayOnceTracker.PlayOnceSpec	PlayOnceTracker.find(IFlow flow, java.lang.String text)
java.lang.String	FieldBinder.getFieldValue(java.lang.String fieldName, IFlow flow) Get the value of the given fieldName, such as "m_main1Prompt".
IFlow	FlowBase.getNext(IFlow current, SRResults results) The default implementation of getNext is to return null.
IFlow	ConfirmationWrapper.getNext(IFlow current, SRResults results) Apply the confirmation based on the state.
IFlow	IFlow.getNext(IFlow current, SRResults results) Gets the next flow object to be executed.
IFlow	TrailWrapper.getNext(IFlow current, SRResults results)
IFlow	FlowBase.getSubFlowAfter(IFlow subFlow)
IFlow	IFlow.getSubFlowAfter(IFlow subFlow) Return the next sub-flow after subFlow.
IFlow	TrailWrapper.getSubFlowAfter(IFlow subFlow)
void	IModelBinder.injectModel(IFlow flow) Set the flow's model field.
void	ModelBinder.injectModel(IFlow flow) A type-agnostic way to assign a model to a flow object.
boolean	IConfirmationFlow.needToExecute(IFlow current, SRResults results) Inspect the results to see if confirmation is needed.
void	ISRInstrumentation.onActivateFlow(int uci, IFlow flow) A flow has been activated (pushed onto the flow stack.
void	ISRInstrumentation.onCallBegin(int uci, IFlow flow) Starting execution of an app on a call.
IFlow	FlowBase.onCatch(IFlow current, SRResults results, java.lang.String eventName, ThrowEvent event) The default implementation of onCatch is to return null, indicating that this object does not handle custom events.
IFlow	IFlow.onCatch(IFlow current, SRResults results, java.lang.String eventName, ThrowEvent event) Event handler for custom events.
IFlow	TrailWrapper.onCatch(IFlow current, SRResults results, java.lang.String eventName, ThrowEvent event)
IFlow	FlowBase.onDisconnect(IFlow current, SRResults results) The default implementation of onDisconnect is to return null, indicating that this object does not handle disconnect events.
IFlow	IFlow.onDisconnect(IFlow current, SRResults results) Event handler for a disconnect event.
IFlow	TrailWrapper.onDisconnect(IFlow current, SRResults results)
void	ISRInstrumentation.onError(int uci, IFlow flow) An error has ocurred.
void	ISRInstrumentation.onExecuteFlow(int uci, IFlow flow) A flow is being executed and will now generate a VoiceXML page.
IFlow	FlowBase.onNoInput(IFlow current, SRResults results) The default implementation of onNoInput is to return null, indicating that this object does not handle no-input events.
IFlow	IFlow.onNoInput(IFlow current, SRResults results) Event handler for the no-input event.
IFlow	TrailWrapper.onNoInput(IFlow current, SRResults results)
IFlow	FlowBase.onPlatformError(IFlow current, SRResults results) The default implementation of onCatch is to return null, indicating that this object does not handle platform errors.
IFlow	IFlow.onPlatformError(IFlow current, SRResults results) Event handler for a error returned by the speech platform.
IFlow	TrailWrapper.onPlatformError(IFlow current, SRResults results)
IFlow	FlowBase.onTransferFailed(IFlow current, SRResults results) The default implementation of onCatch is to return null, indicating that this object does not handle transfer failures.
IFlow	IFlow.onTransferFailed(IFlow current, SRResults results) Event handler for a failed transfer.
IFlow	TrailWrapper.onTransferFailed(IFlow current, SRResults results)
void	ISRInstrumentation.onUserInput(int uci, IFlow flow, SRResults results)
IFlow	FlowBase.onValidateFailed(IFlow current, SRResults results) The default implementation of onValidateFailed is to return null, indicating that this object does not handle validate-failed events.
IFlow	IFlow.onValidateFailed(IFlow current, SRResults results) Event handler for validation failed.
IFlow	TrailWrapper.onValidateFailed(IFlow current, SRResults results)
void	PlayOnceTracker.removeAllFor(IFlow flow)
void	ExecutionContext.render(IFlow flow) Render a flow object into a voicexml page.
void	IExecutionContext.render(IFlow flow) Render the given flow object into a voicexml page.
boolean	SRInstance.runAll(IFlow flow) used for unit tests only.
boolean	SRRunner.runAll(IFlow flow) used for unit tests only.
boolean	SRInstance.start(IFlow flow) Start the application.
boolean	SRRunner.start(IFlow flow) Start the application.

Constructors in org.speakright.core with parameters of type IFlow

ConfirmationWrapper(IFlow question, IConfirmationFlow confirmer)

TrailWrapper(IFlow flow)

Uses of IFlow in org.speakright.core.flows

Classes in org.speakright.core.flows that implement IFlow

class	BasicFlow BasicFlow is a base class for most flow objects.
class	BranchFlow BranchFlow provides branching of the callflow based on an application-defined condition.
static class	BranchFlow.GotoBranchEvent An event class used to jump back from a sub-flow to a branch flow.
class	ChoiceFlow ChoiceFlow provides branching based on user input, such as in a menu.
class	DisconnectFlow A call control flow object that terminates the call by hanging up (playing a goodbye prompt first).
class	FlowList A sequence of flow objects.
class	GotoUrlFlow A flow object that redirects the VoiceXML browser to another URL.
class	LoopFlow Represents looping behaviour.
class	PromptFlow A flow that plays one or more prompts.
class	QuestionFlow Flow object that asks the user a question.
class	RawContentFlow A call control flow object that outputs raw VoiceXML.
class	RecordAudioFlow A flow object that records the caller's audio to an audio file, which is sent back to the application.
class	SRApp The base class for the outermost "app" flow object.
class	TransferFlow A call control flow object that transfers the call.

Fields in org.speakright.core.flows with type parameters of type IFlow

protected java.util.ArrayList<IFlow>

BasicFlow.m_L

Methods in org.speakright.core.flows that return IFlow

protected abstract IFlow	BranchFlow.branch() Derived classes MUST override this and return a flow object to execute.
protected IFlow	SRApp.createGoodbye() Return the final flow object, that is executed after the main loop exits.
protected IFlow	SRApp.createWelcome() Return the first flow object, which is usually a welcome prompt.
IFlow	LoopFlow.getFirst(IFlowContext context)
IFlow	ChoiceFlow.getFirst(IFlowContext context) Returns the choice question.
IFlow	BranchFlow.getFirst(IFlowContext context) Do the branching, as determined by branch()
IFlow	BasicFlow.getFirst(IFlowContext context) If there are sub-flows then return the first one, otherwise return self.
IFlow	LoopFlow.getNext(IFlow current, SRResults results) Get the next sub-flow.
IFlow	ChoiceFlow.getNext(IFlow current, SRResults results) Returns the flow for the choice that matches the user input.
IFlow	BranchFlow.getNext(IFlow current, SRResults results) If m_loopForever set then return this, else null.
IFlow	BasicFlow.getNext(IFlow current, SRResults results) get the next flow.
IFlow	LoopFlow.getSubFlowAfter(IFlow subFlow)
IFlow	BasicFlow.getSubFlowAfter(IFlow subFlow)
IFlow	SRApp.onCatch(IFlow current, SRResults results, java.lang.String eventName, ThrowEvent event) The default implementation of onCatch is to transfer to the operator.
IFlow	BranchFlow.onCatch(IFlow current, SRResults results, java.lang.String eventName, ThrowEvent event) Catch a GotoBranchEvent that is targeted at this object, that is, the event's m_branchName matches our name.
IFlow	SRApp.onDisconnect(IFlow current, SRResults results) The default implementation of onDisconnect is to transfer to the operator.
IFlow	SRApp.onNoInput(IFlow current, SRResults results) The default implementation of onNoInput is to transfer to the operator.
IFlow	SRApp.onPlatformError(IFlow current, SRResults results) The default implementation of onPlatformError is to transfer to the operator.
IFlow	TransferFlow.onTransferFailed(IFlow current, SRResults results) Handle a failed transfer.
IFlow	SRApp.onTransferFailed(IFlow current, SRResults results) The default implementation of onTransferFailed is to transfer to the operator.
IFlow	SRApp.onValidateFailed(IFlow current, SRResults results) The default implementation of onValidateFailed is to transfer to the operator.
protected IFlow	SRApp.transferToOperator() Transfer the call to the operator.

Methods in org.speakright.core.flows with parameters of type IFlow

void	LoopFlow.add(IFlow flow)
void	BasicFlow.add(IFlow flow) add a sub-flow.
void	ChoiceFlow.addChoice(java.lang.String choice, IFlow flow) Adds a choice.
protected int	BasicFlow.findSubFlow(IFlow subFlow) Get the index of subFlow, if its one of our sub-flows
IFlow	LoopFlow.getNext(IFlow current, SRResults results) Get the next sub-flow.
IFlow	ChoiceFlow.getNext(IFlow current, SRResults results) Returns the flow for the choice that matches the user input.
IFlow	BranchFlow.getNext(IFlow current, SRResults results) If m_loopForever set then return this, else null.
IFlow	BasicFlow.getNext(IFlow current, SRResults results) get the next flow.
IFlow	LoopFlow.getSubFlowAfter(IFlow subFlow)
IFlow	BasicFlow.getSubFlowAfter(IFlow subFlow)
IFlow	SRApp.onCatch(IFlow current, SRResults results, java.lang.String eventName, ThrowEvent event) The default implementation of onCatch is to transfer to the operator.
IFlow	BranchFlow.onCatch(IFlow current, SRResults results, java.lang.String eventName, ThrowEvent event) Catch a GotoBranchEvent that is targeted at this object, that is, the event's m_branchName matches our name.
IFlow	SRApp.onDisconnect(IFlow current, SRResults results) The default implementation of onDisconnect is to transfer to the operator.
IFlow	SRApp.onNoInput(IFlow current, SRResults results) The default implementation of onNoInput is to transfer to the operator.
IFlow	SRApp.onPlatformError(IFlow current, SRResults results) The default implementation of onPlatformError is to transfer to the operator.
IFlow	TransferFlow.onTransferFailed(IFlow current, SRResults results) Handle a failed transfer.
IFlow	SRApp.onTransferFailed(IFlow current, SRResults results) The default implementation of onTransferFailed is to transfer to the operator.
IFlow	SRApp.onValidateFailed(IFlow current, SRResults results) The default implementation of onValidateFailed is to transfer to the operator.
protected void	ChoiceFlow.setChoiceQuestion(IFlow flow) Sets the flow object that will ask the choice question.

Constructors in org.speakright.core.flows with parameters of type IFlow

FlowList(IFlow flow1)

FlowList(IFlow flow1, IFlow flow2)

FlowList(IFlow flow1, IFlow flow2, IFlow flow3)

FlowList(IFlow flow1, IFlow flow2, IFlow flow3, IFlow flow4)

FlowList(IFlow flow1, IFlow flow2, IFlow flow3, IFlow flow4, java.lang.String eventName)

FlowList(IFlow flow1, IFlow flow2, IFlow flow3, java.lang.String eventName)

FlowList(IFlow flow1, IFlow flow2, java.lang.String eventName)

FlowList(IFlow flow1, java.lang.String eventName)

Uses of IFlow in org.speakright.core.render

Fields in org.speakright.core.render declared as IFlow

IFlow

RenderContext.m_flow

Uses of IFlow in org.speakright.core.tests

Classes in org.speakright.core.tests that implement IFlow

class	App1
class	AppWithLoop
class	AsyncFlow
class	Flow2Wrapper
static class	InteractiveTester.App2
class	MyFlow
class	MyMenu
class	TestConfirmation.AskCityFlow
static class	TestConfirmation.ConfYNFlow
class	TestModel.EarlyBindingFlow
class	TestNesting.OptionalFlow
class	TestNesting.RepeatFlow
class	TestRender.PlayOnceFlow
class	TestRender.QFlow
class	TestRender.YouSaidFlow
class	TestRender.ZFlow
class	TestSerialization.PFlow
class	TestSerialization.QFlow
class	TestSRApp.TestApp1 plain app that builds its own flow list
class	TestSRApp.TestApp2 app that overrides getWelcome,getMainLoop,and getGoodbye
class	TestSRApp.TestApp3 app that uses goto-events
static class	TestWebServlet2.MyApp
static class	TestWebServlet2.PFlow
static class	TestWebServlet2.QFlow