com.google.code.rees.scope.conversation.annotations
Annotation Type ConversationController


@Target(value=TYPE)
@Retention(value=RUNTIME)
@Documented
public @interface ConversationController

Used to denote an action class is conversation-scoped.

When this annotation is used on an action class, then actions within the class default to be members of the conversations specified by this annotation.

Depending on the ConversationArbitrator being used, by convention any action methods that begin with the word "begin" or "end" are treated as BeginConversation and EndConversation methods, respectively.

If no conversations are specified, then the name of the conversation is derived from the controller class's name minus the specified controller suffix. The default suffix is "Controller". So the conversation for a class named MyExampleFlowController would be my-example-flow. The action suffix can be set as a property on the ConversationArbitrator.

Author:
rees.byars

Optional Element Summary
 String[] conversations
          Used to specify multiple conversations for the controller
 String value
          Used to specify a single conversation for the controller
 

value

public abstract String value
Used to specify a single conversation for the controller

If no conversations are specified, then the name of the conversation is derived from the controller class's name minus the specified controller suffix. The default suffix is "Controller". So the conversation for a class named MyExampleFlowController would be my-example-flow. The action suffix can be set as a property on the ConversationArbitrator.

Default:
"DEFAULT_VALUE"

conversations

public abstract String[] conversations
Used to specify multiple conversations for the controller

If no conversations are specified, then the name of the conversation is derived from the controller class's name minus the specified controller suffix. The default suffix is "Controller". So the conversation for a class named MyExampleFlowController would be my-example-flow. The action suffix can be set as a property on the ConversationArbitrator.

Default:
{}


Copyright © 2012-2013. All Rights Reserved.