org.apache.myfaces.extensions.cdi.jsf.impl.scope.conversation.spi
Interface EditableWindowContext

All Superinterfaces:
AttributeAware, Serializable, WindowContext

public interface EditableWindowContext
extends WindowContext

Allows to implement custom implementations of WindowContext


Method Summary
 EditableConversation createConversation(Class<?> conversationGroup, Annotation... qualifiers)
           
 EditableConversation getConversation(Class<?> conversationGroup, Annotation... qualifiers)
           
 Map<ConversationKey,EditableConversation> getConversations()
          TODO
 Date getLastAccess()
          Date of the last access of the whole WindowContext
 boolean isActive()
           
 boolean isConversationActive(Class<?> conversationGroup, Annotation... qualifiers)
           
 void removeInactiveConversations()
          Removes conversations which are already marked as expired
 void touch()
          Signals that the WindowContext gets used
 
Methods inherited from interface org.apache.myfaces.extensions.cdi.core.api.scope.conversation.WindowContext
close, closeConversation, closeConversationGroup, closeConversations, getConfig, getId
 
Methods inherited from interface org.apache.myfaces.extensions.cdi.core.api.config.AttributeAware
containsAttribute, getAttribute, setAttribute, setAttribute
 

Method Detail

isActive

boolean isActive()
Returns:
evaluates and returns if the context is active

getLastAccess

Date getLastAccess()
Date of the last access of the whole WindowContext

Returns:
date of the last access

touch

void touch()
Signals that the WindowContext gets used


removeInactiveConversations

void removeInactiveConversations()
Removes conversations which are already marked as expired


getConversations

Map<ConversationKey,EditableConversation> getConversations()
TODO

Returns:
all active conversations of the current context

createConversation

EditableConversation createConversation(Class<?> conversationGroup,
                                        Annotation... qualifiers)
Parameters:
conversationGroup - group of the conversation in question
qualifiers - optional qualifiers for the conversation
Returns:
a new conversation for the given group

getConversation

EditableConversation getConversation(Class<?> conversationGroup,
                                     Annotation... qualifiers)
Parameters:
conversationGroup - group of the conversation in question
qualifiers - optional qualifiers for the conversation
Returns:
a new conversation for the given group

isConversationActive

boolean isConversationActive(Class<?> conversationGroup,
                             Annotation... qualifiers)
Parameters:
conversationGroup - group of the conversation in question
qualifiers - optional qualifiers for the conversation
Returns:
true if the conversation exists and is active, false otherwise


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