org.springframework.webflow.conversation
Interface ConversationManager

All Known Implementing Classes:

SessionBindingConversationManager

public interface ConversationManager

A service for managing conversations. This interface is the entry point into the conversation subsystem.

Author:

Keith Donald

Method Summary

Conversation	beginConversation(ConversationParameters conversationParameters) Begin a new conversation.
Conversation	getConversation(ConversationId id) Get the conversation with the provided id.
ConversationId	parseConversationId(java.lang.String encodedId) Parse the string-encoded conversationId into its object form.

Method Detail

beginConversation

Conversation beginConversation(ConversationParameters conversationParameters)
                               throws ConversationException

Begin a new conversation.

Parameters:

conversationParameters - descriptive conversation parameters

Returns:

a service interface allowing access to the conversation context

Throws:

ConversationException - an exception occured

getConversation

Conversation getConversation(ConversationId id)
                             throws ConversationException

Get the conversation with the provided id.

Parameters:

id - the conversation id

Returns:

the conversation

Throws:

NoSuchConversationException - the id provided was invalid

ConversationException

parseConversationId

ConversationId parseConversationId(java.lang.String encodedId)
                                   throws ConversationException

Parse the string-encoded conversationId into its object form. Essentially, the reverse of ConversationId.toString().

Parameters:

encodedId - the encoded id

Returns:

the parsed conversation id

Throws:

ConversationException - an exception occured parsing the id