001/*
002 * GWTEventService
003 * Copyright (c) 2011 and beyond, strawbill UG (haftungsbeschr?nkt)
004 *
005 * This is free software; you can redistribute it and/or modify it
006 * under the terms of the GNU Lesser General Public License as
007 * published by the Free Software Foundation; either version 3 of
008 * the License, or (at your option) any later version.
009 * Other licensing for GWTEventService may also be possible on request.
010 * Please view the license.txt of the project for more information.
011 *
012 * This software is distributed in the hope that it will be useful,
013 * but WITHOUT ANY WARRANTY; without even the implied warranty of
014 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
015 * Lesser General Public License for more details.
016 *
017 * You should have received a copy of the GNU Lesser General Public
018 * License along with this software; if not, write to the Free
019 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
020 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
021 */
022package de.novanic.eventservice.client.event.filter;
023
024import java.util.List;
025
026/**
027 * A CompositeEventFilter can handle various attached {@link de.novanic.eventservice.client.event.filter.EventFilter} instances.
028 * The match method calls all attached {@link de.novanic.eventservice.client.event.filter.EventFilter} instances to check if the
029 * {@link de.novanic.eventservice.client.event.Event} has to be filtered.
030 * A other solution to build filter sequences is available with {@link CascadingEventFilter} (cascading filter sequences).
031 *
032 * @author sstrohschein
033 *         <br>Date: 05.03.2009
034 *         <br>Time: 12:06:49
035 */
036public interface CompositeEventFilter extends AppendableEventFilter
037{
038    /**
039     * Returns the attached EventFilters.
040     * EventFilter instances can be attached with {@link de.novanic.eventservice.client.event.filter.AppendableEventFilter#attach(EventFilter)}.
041     * @return the attached {@link de.novanic.eventservice.client.event.filter.EventFilter}
042     */
043    List<EventFilter> getAttachedEventFilters();
044
045    /**
046     * Detaches the attached {@link de.novanic.eventservice.client.event.filter.EventFilter} instances.
047     * EventFilter instances can be attached with {@link de.novanic.eventservice.client.event.filter.AppendableEventFilter#attach(EventFilter)}.
048     * @param anEventFilter {@link de.novanic.eventservice.client.event.filter.EventFilter} to detach
049     * @return true if the EventFilter was removed with that call, otherwise false
050     */
051    boolean detach(EventFilter anEventFilter);
052
053    /**
054     * Detaches all attached {@link de.novanic.eventservice.client.event.filter.EventFilter} instances.
055     * EventFilter instances can be attached with {@link de.novanic.eventservice.client.event.filter.AppendableEventFilter#attach(EventFilter)}.
056     * @return true if at least one EventFilter was removed with that call, otherwise false
057     */
058    boolean detach();
059}