com.nuecho.rivr.core.dialogue

Interface Dialogue<I extends InputTurn,O extends OutputTurn,F extends FirstTurn,L extends LastTurn,C extends DialogueContext<I,O>>

Type Parameters:

F - type of FirstTurn

L - type of LastTurn

O - type of OutputTurn

I - type of InputTurn

C - type of DialogueContext

All Known Subinterfaces:

VoiceXmlDialogue

public interface Dialogue<I extends InputTurn,O extends OutputTurn,F extends FirstTurn,L extends LastTurn,C extends DialogueContext<I,O>>

Rivr applications are expected to provide one or many implementations of this interface or its subtypes. This interface provides a single method performing the dialogue, i.e. sequence of turn exchanges with the DialogueChannel and dialogue-related logic.

Method Summary

Modifier and Type	Method and Description
L	run(F firstTurn, C context) Method called by the controller (e.g.

Method Detail

run

L run(F firstTurn,
      C context)
throws Exception

Method called by the controller (e.g. DialogueServlet) to run the dialogue. It takes initial parameters from the firstTurn parameter and must return a LastTurn. The context allows the dialogue to access the DialogueChannel on which turn exchanges can be performed (i.e. exchanges of OutputTurns and InputTurns).

Parameters:

firstTurn - First turn. Contains dialogue initialization information. Cannot be null.

context - Dialogue context. This context gives access to DialogueChannel, a Logger and the dialogue ID. Cannot be null.

Returns:

the result of the dialogue as a LastTurn. Cannot be null.

Throws:

Exception - when something prevents the dialogue from completing normally.