org.speakright.core.flows
Class BranchFlow.GotoBranchEvent

java.lang.Object
  org.speakright.core.FlowBase
      org.speakright.core.ControlFlow
          org.speakright.core.ThrowEvent
              org.speakright.core.AppEvent
                  org.speakright.core.flows.BranchFlow.GotoBranchEvent

All Implemented Interfaces:

java.io.Serializable, IFlow

Enclosing class:

BranchFlow

public static class BranchFlow.GotoBranchEvent
extends AppEvent

An event class used to jump back from a sub-flow to a branch flow. Since there may be multiple branch flows in an app, the event includes m_branchName, which is the name of the flow object to jump to. An additional m_action field is used to control the branching. Sub-flows can set this when 'throwing' this event in in order to control which branch is taken.

Author:

IanRaeLaptop

See Also:

Serialized Form

Field Summary

java.lang.String	m_action
java.lang.String	m_branchName

Constructor Summary

BranchFlow.GotoBranchEvent(java.lang.String branchName, java.lang.String action)

Method Summary

Methods inherited from class org.speakright.core.FlowBase

createRenderer, execute, executionCount, fixupGrammar, fixupPrompt, getFirst, getNext, getSubFlowAfter, log, logError, name, onBegin, onCatch, onComplete, onDisconnect, onEnd, onNoInput, onPlatformError, onTransferFailed, onValidateFailed, promptGroup, setExecutionCount, setName, setPromptGroup, shouldExecute, validateInput

Methods inherited from class java.lang.Object

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

Field Detail

m_branchName

public java.lang.String m_branchName

m_action

public java.lang.String m_action

Constructor Detail

BranchFlow.GotoBranchEvent

public BranchFlow.GotoBranchEvent(java.lang.String branchName,
                                  java.lang.String action)