org.speakright.core
Class AppEvent

java.lang.Object
  org.speakright.core.FlowBase
      org.speakright.core.ControlFlow
          org.speakright.core.ThrowEvent
              org.speakright.core.AppEvent

All Implemented Interfaces:

java.io.Serializable, IFlow

Direct Known Subclasses:

BranchFlow.GotoBranchEvent

public class AppEvent
extends ThrowEvent

An application event is is a custom event that an application can "throw" in order to transfer control to another active flow object. Think of "throwing" an event as a restricted type of goto. App events are useful for handling generic behaviour in a single place in the application.

For example, an "operator" event could be used to cause the application to transfer to a human operator.

Author:

Ian Rae

See Also:

Serialized Form

Constructor Summary

AppEvent(java.lang.String eventName)
Create an application event.

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

Constructor Detail

AppEvent

public AppEvent(java.lang.String eventName)

Create an application event.

Parameters:

eventName - event name. Applications define their own event names.