001    /**
002     * Copyright 2005-2013 The Kuali Foundation
003     *
004     * Licensed under the Educational Community 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.opensource.org/licenses/ecl2.php
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    package org.kuali.rice.ken.service;
017    
018    import java.util.Collection;
019    
020    import org.kuali.rice.ken.bo.NotificationChannelBo;
021    
022    /**
023     * Service for accessing {@link org.kuali.rice.ken.bo.NotificationChannelBo}s
024     * @author Kuali Rice Team (rice.collab@kuali.org)
025     */
026    public interface NotificationChannelService {
027        /**
028         * This method returns all of the registered notification channels in the system.
029         * @return Collection
030         */
031        public Collection<NotificationChannelBo> getAllNotificationChannels();
032        
033        /**
034         * This method retrieves a specific NotificationChannel instance by id.  If none is found, it returns null.
035         * @param id
036         * @return NotificationChannel
037         */
038        public NotificationChannelBo getNotificationChannel(String id);
039        
040        /**
041         * This method retrieves a specific NotificationChannel instance by name.  If none is found, it returns null.
042         * @param id
043         * @return NotificationChannel
044         */
045        public NotificationChannelBo getNotificationChannelByName(String name);
046        
047        /**
048         * This method retrieves all channels in the system that can be subscribed to.
049         * @return Collection
050         */
051        public Collection<NotificationChannelBo> getSubscribableChannels();
052    }