org.jboss.seam.annotations
Annotation Type End

@Target(value=METHOD)
@Retention(value=RUNTIME)
@Documented
public @interface End

Marks a method as ending a conversation, if the method returns a non-null outcome without throwing an exception. If a list of outcomes is specified, the conversation ends only if the outcome is in the list. A null outcome never ends the conversation. If the method is of type void, the conversation always ends.

Author:

Gavin King

Optional Element Summary

boolean	beforeRedirect Should the conversation be destroyed before any redirect?
String[]	ifOutcome Deprecated. use Conversation.instance().end()
boolean	root If the conversation is nested, should the root of the conversation be destroyed?

ifOutcome

public abstract String[] ifOutcome

Deprecated. use Conversation.instance().end()

An empty outcome list is interpreted to mean any outcome except for the null (redisplay) outcome.

Default:

{}

beforeRedirect

public abstract boolean beforeRedirect

Should the conversation be destroyed before any redirect? (The default behavior is to propagate the conversation across the redirect and then destroy it at the end of the redirected request.)

Returns:

false by default

Default:

false

root

public abstract boolean root

If the conversation is nested, should the root of the conversation be destroyed? (The default behavior is to simply pop the conversation stack.)

Returns:

false by default

Default:

false