/* | |
* Licensed to the Apache Software Foundation (ASF) under one | |
* or more contributor license agreements. See the NOTICE file | |
* distributed with this work for additional information | |
* regarding copyright ownership. The ASF licenses this file | |
* to you under the Apache License, Version 2.0 (the | |
* "License"); you may not use this file except in compliance | |
* with the License. You may obtain a copy of the License at | |
* | |
* http://www.apache.org/licenses/LICENSE-2.0 | |
* | |
* Unless required by applicable law or agreed to in writing, | |
* software distributed under the License is distributed on an | |
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | |
* KIND, either express or implied. See the License for the | |
* specific language governing permissions and limitations | |
* under the License. | |
*/ | |
package org.apache.myfaces.extensions.cdi.core.api.scope.conversation; | |
import org.apache.myfaces.extensions.cdi.core.api.config.AttributeAware; | |
import java.io.Serializable; | |
import java.lang.annotation.Annotation; | |
/** | |
* @author Gerhard Petracek | |
*/ | |
public interface WindowContext extends AttributeAware, Serializable | |
{ | |
String CURRENT_WINDOW_CONTEXT_BEAN_NAME = "currentWindowContext"; | |
/** | |
* @return the id of the conversation (unique for each window/tab) | |
*/ | |
Long getId(); | |
/** | |
* TODO add: endContext to reset the window scope | |
* invalidate all conversations immediately | |
* attention: window scoped beans won't get destroyed. | |
* currently there is no api for it. | |
* (if it is needed you have to call {@link #endConversation} in combination with the | |
* {@link org.apache.myfaces.extensions.cdi.core.api.scope.conversation.WindowGroup}) | |
*/ | |
void endConversations(); | |
/** | |
* @param conversationGroup group of the conversation in question | |
* @param qualifiers optional qualifiers for the conversation | |
* @return a new conversation for the given group | |
*/ | |
Conversation createConversation(Class conversationGroup, Annotation... qualifiers); | |
/** | |
* @param conversationGroup group of the conversation in question | |
* @param qualifiers optional qualifiers for the conversation | |
* @return a new conversation for the given group | |
*/ | |
Conversation getConversation(Class conversationGroup, Annotation... qualifiers); | |
/** | |
* @param conversationGroup group of the conversation in question | |
* @param qualifiers optional qualifiers for the conversation | |
* @return the removed conversation - null otherwise | |
*/ | |
Conversation endConversation(Class conversationGroup, Annotation... qualifiers); | |
/** | |
* @return configuration of the current context | |
*/ | |
WindowContextConfig getConfig(); | |
} |