org.jvoicexml.event.plain.implementation

Class SynthesizedOutputEvent

java.lang.Object

java.lang.Throwable

org.jvoicexml.event.JVoiceXMLEvent

org.jvoicexml.event.plain.implementation.SynthesizedOutputEvent

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

MarkerReachedEvent, OutputEndedEvent, OutputStartedEvent, QueueEmptyEvent

public class SynthesizedOutputEvent
extends JVoiceXMLEvent

Event generated from the SynthesizedOutput implementation. Events are associated to a dedicated event source, i.e. the system output device, and a session.

Since:

0.6

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
SynthesizedOutputEvent(SynthesizedOutput output, java.lang.String detailedType, java.lang.String id) Constructs a new object.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getEventType() Get the event type of this event.
java.lang.String	getSessionId() Retrieves the session id.
SynthesizedOutput	getSource() Retrieves the object that caused the event.

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

SynthesizedOutputEvent

public SynthesizedOutputEvent(SynthesizedOutput output,
                              java.lang.String detailedType,
                              java.lang.String id)
                       throws java.lang.IllegalArgumentException

Constructs a new object.

Parameters:

output - object that caused the event.

detailedType - the detailed message

id - the session id

Throws:

java.lang.IllegalArgumentException - if an illegal event type is passed.

Method Detail

getSource

public final SynthesizedOutput getSource()

Retrieves the object that caused the event.

Returns:

the source object.

getSessionId

public final java.lang.String getSessionId()

Retrieves the session id.

Returns:

the session id

Since:

0.7.5

getEventType

public java.lang.String getEventType()

Get the event type of this event.

Specified by:

getEventType in class JVoiceXMLEvent

Returns:

Event type.