org.apache.myfaces.extensions.cdi.core.api.scope.conversation
Interface WindowContext

All Superinterfaces:
AttributeAware, Serializable

public interface WindowContext
extends AttributeAware, Serializable

Interface for handling the current window context as well as the conversations of the current window.


Method Summary
 void close()
          invalidate the whole WindowContext it also invalidates all Codi conversations immediately.
 Conversation closeConversation(Class<?> conversationGroup, Annotation... qualifiers)
           
 Set<Conversation> closeConversationGroup(Class<?> conversationGroup)
          destroys all conversation of a group independent of the qualifiers
 void closeConversations()
          invalidate all conversations immediately attention: window scoped beans won't get destroyed.
 WindowContextConfig getConfig()
           
 String getId()
           
 
Methods inherited from interface org.apache.myfaces.extensions.cdi.core.api.config.AttributeAware
containsAttribute, getAttribute, setAttribute, setAttribute
 

Method Detail

getId

String getId()
Returns:
the id of the conversation (unique for each window/tab)

closeConversation

Conversation closeConversation(Class<?> conversationGroup,
                               Annotation... qualifiers)
Parameters:
conversationGroup - group of the conversation in question
qualifiers - optional qualifiers for the conversation
Returns:
the removed conversation - null otherwise

closeConversationGroup

Set<Conversation> closeConversationGroup(Class<?> conversationGroup)
destroys all conversation of a group independent of the qualifiers

Parameters:
conversationGroup - group of the conversation in question
Returns:
the removed conversation - null otherwise

closeConversations

void closeConversations()
invalidate all conversations immediately attention: window scoped beans won't get destroyed. if you would like to reset the whole context including window scoped beans, use close() or closeConversation(java.lang.Class, java.lang.annotation.Annotation...) + WindowScoped.class as argument


close

void close()
invalidate the whole WindowContext it also invalidates all Codi conversations immediately.


getConfig

WindowContextConfig getConfig()
Returns:
configuration of the current context


Copyright © 2010-2012 The Apache Software Foundation. All Rights Reserved.