org.jvoicexml

Interface PromptAccumulator

All Known Subinterfaces:

ImplementationPlatform

All Known Implementing Classes:

JVoiceXmlImplementationPlatform

public interface PromptAccumulator

A prompt accumulator collects all the prompts that are to be rendered in the SystemOutput.

Since:

0.7.4

Method Summary

Modifier and Type	Method and Description
void	queuePrompt(SpeakableText speakable) Queues the given prompt without rendereing it.
void	renderPrompts(java.lang.String sessionId, DocumentServer server, CallControlProperties callProps) Notifies the implementation platform about the end of the prompt queuing that has been started by setPromptTimeout(long).
void	setPromptTimeout(long timeout) Sets the default timeout to use.

Method Detail

setPromptTimeout

void setPromptTimeout(long timeout)

Sets the default timeout to use.

This method is intended to be called prior to queuing prompts via queuePrompt(SpeakableText), so it also clears the list of queued prompts.

Parameters:

timeout - default timeout.

queuePrompt

void queuePrompt(SpeakableText speakable)

Queues the given prompt without rendereing it.

After all prompts have been queued, the end of prompt queuing must be indicated by renderPrompts(String, DocumentServer, CallControlProperties).

Parameters:

speakable - the prompt to queue.

renderPrompts

void renderPrompts(java.lang.String sessionId,
                   DocumentServer server,
                   CallControlProperties callProps)
            throws BadFetchError,
                   NoresourceError,
                   ConnectionDisconnectHangupEvent

Notifies the implementation platform about the end of the prompt queuing that has been started by setPromptTimeout(long).

It is assumed that the PromptAccumulator has knowledge about the ImplementationPlatform to render the output.

Parameters:

sessionId - the current session id

server - the document server to use

callProps - properties for the call control

Throws:

BadFetchError - error queuing the prompt

NoresourceError - Output device is not available.

ConnectionDisconnectHangupEvent - the user hung up