com.google.code.rees.scope.conversation.configuration
Class ConversationClassConfiguration

java.lang.Object
  com.google.code.rees.scope.conversation.configuration.ConversationClassConfiguration

public class ConversationClassConfiguration
extends Object

This class is used to cache the fields and action IDs for a single class for a single conversation.

Author:

rees.byars

See Also:

ConversationConfigurationProvider}, ConversationProcessor}

Constructor Summary

ConversationClassConfiguration(String conversationName)

Method Summary

void	addAction(String actionId) Add an actionId for an intermediate action
void	addBeginAction(String actionId, Long maxIdleTimeMillis) Add an actionId for a begin action
void	addEndAction(String actionId) Add an actionId for an end action
void	addField(String name, Field field) Add a field to the configuration
boolean	containsAction(String actionId) Indicates whether the actionId identifies the action as an intermediate member for this conversation
String	getConversationName() Returns the name of the conversation that this configuration is for
Map<String,Field>	getFields() Get the cached fields for conversation
long	getMaxIdleTime(String beginActionId) given the begin action's ID, returns the max idle time (in milliseconds) for the conversation created by that action
boolean	isBeginAction(String actionId) Indicates whether the actionId identifies the action as a begin member for this conversation
boolean	isEndAction(String actionId) Indicates whether the actionId identifies the action as an end member for this conversation

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ConversationClassConfiguration

public ConversationClassConfiguration(String conversationName)

Method Detail

addField

public void addField(String name,
                     Field field)

Add a field to the configuration

Parameters:

name -

field -

getFields

public Map<String,Field> getFields()

Get the cached fields for conversation

Returns:

addAction

public void addAction(String actionId)

Add an actionId for an intermediate action

Parameters:

actionId -

See Also:

ConversationAdapter#getActionId()}, ConversationArbitrator#getName(Method)}

addBeginAction

public void addBeginAction(String actionId,
                           Long maxIdleTimeMillis)

Add an actionId for a begin action

Parameters:

actionId -

See Also:

ConversationAdapter#getActionId()}, ConversationArbitrator#getName(Method)}

addEndAction

public void addEndAction(String actionId)

Add an actionId for an end action

Parameters:

actionId -

See Also:

ConversationAdapter#getActionId()}, ConversationArbitrator#getName(Method)}

containsAction

public boolean containsAction(String actionId)

Indicates whether the actionId identifies the action as an intermediate member for this conversation

Parameters:

actionId -

Returns:

See Also:

ConversationAdapter#getActionId()}, ConversationArbitrator#getName(Method)}

isBeginAction

public boolean isBeginAction(String actionId)

Indicates whether the actionId identifies the action as a begin member for this conversation

Parameters:

actionId -

Returns:

See Also:

ConversationAdapter#getActionId()}, ConversationArbitrator#getName(Method)}

isEndAction

public boolean isEndAction(String actionId)

Indicates whether the actionId identifies the action as an end member for this conversation

Parameters:

actionId -

Returns:

See Also:

ConversationAdapter#getActionId()}, ConversationArbitrator#getName(Method)}

getMaxIdleTime

public long getMaxIdleTime(String beginActionId)

given the begin action's ID, returns the max idle time (in milliseconds) for the conversation created by that action

Parameters:

beginActionId -

Returns:

getConversationName

public String getConversationName()

Returns the name of the conversation that this configuration is for

Returns: