001/*
002 * (C) Copyright 2007 Nuxeo SA (http://nuxeo.com/) and others.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *     http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 *
016 * Contributors:
017 *     Nuxeo - initial API and implementation
018 *
019 * $Id$
020 */
021
022package org.nuxeo.ecm.platform.notification.api;
023
024import java.io.Serializable;
025import java.util.List;
026import java.util.Set;
027
028/**
029 * This class holds data about the notifications.
030 *
031 * @author <a href="mailto:npaslaru@nuxeo.com">Narcis Paslaru</a>
032 */
033public interface NotificationRegistry extends Serializable {
034
035    void clear();
036
037    void registerNotification(Notification notif, List<String> events);
038
039    @Deprecated
040    /**
041     * Deperecated since 5.7.2. Prefer to use unregisterNotification(Notification notif)
042     */
043    void unregisterNotification(Notification notif, List<String> events);
044
045    /**
046     * Gets the list of event names used by notifications.
047     *
048     * @since 5.4.2
049     */
050    Set<String> getNotificationEventNames();
051
052    List<Notification> getNotificationsForEvent(String eventId);
053
054    List<Notification> getNotifications();
055
056    List<Notification> getNotificationsForSubscriptions(String parentType);
057
058    /**
059     * Unregister notification contribution and remove reference in event registry
060     *
061     * @since 5.6
062     */
063    void unregisterNotification(Notification notif);
064
065}