org.jvoicexml.event.plain.jvxml

Class ReturnEvent

java.lang.Object

java.lang.Throwable

org.jvoicexml.event.JVoiceXMLEvent

org.jvoicexml.event.PlainEvent

org.jvoicexml.event.plain.jvxml.ReturnEvent

All Implemented Interfaces:

java.io.Serializable

public final class ReturnEvent
extends PlainEvent

The FIA processed a <return> event.

Since:

0.3

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	EVENT_TYPE The detail message.

Constructor Summary

Constructors

Constructor and Description
ReturnEvent(java.util.Map<java.lang.String,java.lang.Object> mappings) Constructs a new object with the given namelist as return value.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getEventType() Get the event type of this event.
java.util.Map<java.lang.String,java.lang.Object>	getVariables() Retrieves the variable names to be passed to the interpreter context.

Methods inherited from class org.jvoicexml.event.JVoiceXMLEvent

getMessage, isType

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Field Detail

EVENT_TYPE

public static final java.lang.String EVENT_TYPE

The detail message.

Constructor Detail

ReturnEvent

public ReturnEvent(java.util.Map<java.lang.String,java.lang.Object> mappings)

Constructs a new object with the given namelist as return value.

Parameters:

mappings - Variable names to be returned to the interpreter.

Method Detail

getEventType

public java.lang.String getEventType()

Get the event type of this event.

Specified by:

getEventType in class JVoiceXMLEvent

Returns:

Event type.

getVariables

public java.util.Map<java.lang.String,java.lang.Object> getVariables()

Retrieves the variable names to be passed to the interpreter context.

Returns:

Variable names and their values.