com.google.code.rees.scope.conversation.configuration
Interface ConversationArbitrator

All Superinterfaces:

Serializable

All Known Implementing Classes:

DefaultConversationArbitrator, SpringConversationArbitrator, StrutsConversationArbitrator

public interface ConversationArbitrator
extends Serializable

This class is used by a ConversationConfigurationProvider to determine which field and method members to associate with conversations.

Author:

rees.byars

Method Summary

Collection<String>	getBeginConversations(Class<?> clazz, Method method) returns a collection of conversation names for the method as a begin point
Collection<Field>	getCandidateConversationFields(Class<?> clazz) Returns a collection of candidate conversation fields from a class.
Collection<Method>	getCandidateConversationMethods(Class<?> clazz) Returns a collection of candidate conversation action methods from a class.
Collection<String>	getConversations(Class<?> clazz, Field field) Returns a collection of conversation names for the field
Collection<String>	getConversations(Class<?> clazz, Method method) returns a collection of conversation names for the method as an intermediate point
Collection<String>	getEndConversations(Class<?> clazz, Method method) returns a collection of conversation names for the method as an end point
String	getName(Field field) returns the name to be used for the field as a key in the conversation context
String	getName(Method method) returns the name to be used as an actionId
void	setActionSuffix(String suffix) The default suffix is "Controller".

Method Detail

setActionSuffix

void setActionSuffix(String suffix)

The default suffix is "Controller". So the conversation for a class named MyExampleFlowController would be my-example-flow. Use this setter to use a different suffix.

Parameters:

suffix -

getCandidateConversationFields

Collection<Field> getCandidateConversationFields(Class<?> clazz)

Returns a collection of candidate conversation fields from a class. Subsequent calls are made to the getConversations(Class, Field) to determine which, if any, conversations the field should be included with

Parameters:

clazz -

Returns:

getCandidateConversationMethods

Collection<Method> getCandidateConversationMethods(Class<?> clazz)

Returns a collection of candidate conversation action methods from a class. Subsequent calls are made to the getConversations(Class, Method) to determine which, if any, conversations the method should be included with

Parameters:

clazz -

Returns:

getConversations

Collection<String> getConversations(Class<?> clazz,
                                    Field field)

Returns a collection of conversation names for the field

Parameters:

clazz -

field -

Returns:

getConversations

Collection<String> getConversations(Class<?> clazz,
                                    Method method)

returns a collection of conversation names for the method as an intermediate point

Parameters:

clazz -

method -

Returns:

See Also:

com.google.code.rees.scope.conversation.annotations.ConversationAction ConversationAction}

getName

String getName(Field field)

returns the name to be used for the field as a key in the conversation context

Parameters:

field -

Returns:

getName

String getName(Method method)

returns the name to be used as an actionId

Parameters:

method -

Returns:

See Also:

ConversationAdapter#getActionId()}

getBeginConversations

Collection<String> getBeginConversations(Class<?> clazz,
                                         Method method)

returns a collection of conversation names for the method as a begin point

Parameters:

clazz -

method -

Returns:

See Also:

com.google.code.rees.scope.conversation.annotations.BeginConversation BeginConversation}

getEndConversations

Collection<String> getEndConversations(Class<?> clazz,
                                       Method method)

returns a collection of conversation names for the method as an end point

Parameters:

clazz -

method -

Returns:

See Also:

com.google.code.rees.scope.conversation.annotations.EndConversation EndConversation}