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

All Superinterfaces:
Serializable, org.apache.myfaces.extensions.cdi.core.impl.scope.conversation.spi.WindowContextManager
All Known Implementing Classes:
DefaultWindowContextManager, EditableWindowContextManagerProxy

public interface EditableWindowContextManager
extends org.apache.myfaces.extensions.cdi.core.impl.scope.conversation.spi.WindowContextManager

Allows to implement custom implementations of WindowContextManager


Field Summary
 
Fields inherited from interface org.apache.myfaces.extensions.cdi.core.impl.scope.conversation.spi.WindowContextManager
AUTOMATED_ENTRY_POINT_PARAMETER_KEY, WINDOW_CONTEXT_ID_PARAMETER_KEY
 
Method Summary
 boolean activateWindowContext(EditableWindowContext windowContext)
          Activates the given WindowContext
 boolean activateWindowContext(String windowContextId)
          Activates the WindowContext with has the given window-id.
 void closeAllWindowContexts()
          Closes all WindowContext of the current user(-session)
 void closeCurrentWindowContext()
          Closes all conversations of the current WindowContext
 void closeWindowContext(EditableWindowContext windowContext)
          Closes all conversations of the given WindowContext
 void closeWindowContext(String windowContextId)
          Closes all conversations of the WindowContext with the given window-id
 Collection<EditableWindowContext> getWindowContexts()
          Exposes all WindowContext instances for the current user(-session)
 boolean isWindowContextActive(String windowContextId)
          Evaluates if the WindowContext with the given window-id is currently active
 void restartConversations()
          Restarts all conversations of the current WindowContext
 void restartConversations(EditableWindowContext windowContext)
          Restarts all conversations of the given WindowContext
 void restartConversations(String windowContextId)
          Restarts all conversations of the WindowContext with the given window-id
 
Methods inherited from interface org.apache.myfaces.extensions.cdi.core.impl.scope.conversation.spi.WindowContextManager
getCurrentWindowContext, getWindowContext
 

Method Detail

activateWindowContext

boolean activateWindowContext(String windowContextId)
Activates the WindowContext with has the given window-id. If there is no WindowContext which has the given id a new context will be created automatically.

Parameters:
windowContextId - window-id
Returns:
true if the context was created successfully, false otherwise

activateWindowContext

boolean activateWindowContext(EditableWindowContext windowContext)
Activates the given WindowContext

Parameters:
windowContext - window-context which has to be activated
Returns:
true if the context was created successfully, false otherwise

restartConversations

void restartConversations()
Restarts all conversations of the current WindowContext


restartConversations

void restartConversations(String windowContextId)
Restarts all conversations of the WindowContext with the given window-id

Parameters:
windowContextId - current window-id

restartConversations

void restartConversations(EditableWindowContext windowContext)
Restarts all conversations of the given WindowContext

Parameters:
windowContext - window-context which will be restarted (the conversations of it)

closeCurrentWindowContext

void closeCurrentWindowContext()
Closes all conversations of the current WindowContext


closeWindowContext

void closeWindowContext(String windowContextId)
Closes all conversations of the WindowContext with the given window-id

Parameters:
windowContextId - current window-id

closeWindowContext

void closeWindowContext(EditableWindowContext windowContext)
Closes all conversations of the given WindowContext

Parameters:
windowContext - window-context which will be closed (the conversations of it)

getWindowContexts

Collection<EditableWindowContext> getWindowContexts()
Exposes all WindowContext instances for the current user(-session)

Returns:
all window-contexts available in the current user(-session)

closeAllWindowContexts

void closeAllWindowContexts()
Closes all WindowContext of the current user(-session)


isWindowContextActive

boolean isWindowContextActive(String windowContextId)
Evaluates if the WindowContext with the given window-id is currently active

Parameters:
windowContextId - current window-id
Returns:
true if the window-context with the given id is active, false otherwise


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