org.jboss.seam.security.external.dialogues.api

Interface DialogueManager

All Known Implementing Classes:

DialogueManagerBean

public interface DialogueManager

Manager for the dialogue scope. For background about the dialogue scope, see DialogueScoped.

Author:

Marcel Kolsteren

Method Summary

Methods

Modifier and Type	Method and Description
void	attachDialogue(String dialogueId) Attaches the current thread to the given dialogue.
void	beginDialogue() Starts a new dialogue.
void	detachDialogue() Detaches the current thread from the dialogue.
void	endDialogue() Ends the current dialogue.
boolean	isAttached() Checks whether the current thread is attached to a dialogue (i.e.
boolean	isExistingDialogue(String dialogueId) Checks whether a dialogue exists with the given id.

Method Detail

beginDialogue

void beginDialogue()

Starts a new dialogue. Results in a RuntimeException if isAttached() is true.

endDialogue

void endDialogue()

Ends the current dialogue. Results in a RuntimeException if isAttached() is false.

isExistingDialogue

boolean isExistingDialogue(String dialogueId)

Checks whether a dialogue exists with the given id.

Parameters:

dialogueId - the id

Returns:

true if a dialogue with that id exists

isAttached

boolean isAttached()

Checks whether the current thread is attached to a dialogue (i.e. whether a dialogue is currently active)

Returns:

true if the current thread is attached to a dialogue

attachDialogue

void attachDialogue(String dialogueId)

Attaches the current thread to the given dialogue. Results in a RuntimeException if the thread is already attached to a dialogue, i.e. if isAttached() is true.

Parameters:

dialogueId -

detachDialogue

void detachDialogue()

Detaches the current thread from the dialogue. Results in a RuntimeException if isAttached() is false.