package org.jacorb.notification.interfaces;

/*
 *        JacORB - a free Java ORB
 *
 *   Copyright (C) 1999-2014 Gerald Brose / The JacORB Team.
 *
 *   This library is free software; you can redistribute it and/or
 *   modify it under the terms of the GNU Library General Public
 *   License as published by the Free Software Foundation; either
 *   version 2 of the License, or (at your option) any later version.
 *
 *   This library is distributed in the hope that it will be useful,
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *   Library General Public License for more details.
 *
 *   You should have received a copy of the GNU Library General Public
 *   License along with this library; if not, write to the Free
 *   Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 *
 */

import java.util.List;

import org.omg.CosNotifyFilter.MappingFilter;

/**
 * Abstraction of a ProxyConsumer, SupplierAdmin, ConsumerAdmin,
 * ProxySupplier. This Interface provides uniform access the methods
 * which are relevant during processing of a Message.
 *
 * @author Alphonse Bendt
 */

public interface FilterStage extends FilterStageSource
{
    /**
     * check if this FilterStage has been disposed.
     */
    boolean isDestroyed();

    /**
     * get Filters associated to this FilterStage.
     */
    List getFilters();

    /**
     * check if this FilterStage has a MessageConsumer associcated.
     */
    boolean hasMessageConsumer();

    /**
     * check if this FilterStage has OR Semantic enabled.
     */
    boolean hasInterFilterGroupOperatorOR();

    /**
     * get the associated MessageConsumer or null.
     */
    MessageConsumer getMessageConsumer();

    /**
     * check if this FilterStage has a LifetimeFilter attached
     */
    boolean hasLifetimeFilter();

    /**
     * check if this FilterStage has a PriorityFilter attached
     */
    boolean hasPriorityFilter();

    /**
     * access the LifetimeFilter attached to this FilterStage
     * @return a LifetimeFilter or null if no Filter is attached
     */
    MappingFilter getLifetimeFilter();

    /**
     * access the PriorityFilter attached to this FilterStage
     * @return a PriorityFilter or null if no Filter is attached
     */
    MappingFilter getPriorityFilter();
}