/*
 * 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.deltaspike.core.spi.scope.conversation;

import org.apache.deltaspike.core.util.context.ContextualStorage;

import java.io.Serializable;
import java.lang.annotation.Annotation;
import java.util.Set;

public interface GroupedConversationManager extends Serializable
{
    /**
     * @param conversationGroup group of the conversation in question
     * @param qualifiers        optional qualifiers for the conversation
     * @return the removed conversation - null otherwise
     */
    ContextualStorage closeConversation(Class<?> conversationGroup, Annotation... qualifiers);

    /**
     * destroys all conversation of a group independent of the qualifiers
     *
     * @param conversationGroup group of the conversation in question
     * @return the removed storages - null otherwise
     */
    Set<ContextualStorage> closeConversationGroup(Class<?> conversationGroup);

    /**
     * invalidate all conversations immediately (within the current window)
     */
    void closeConversations();
}
