1 /**
2 * Copyright 2005-2011 The Kuali Foundation
3 *
4 * Licensed under the Educational Community License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.opensource.org/licenses/ecl2.php
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16 package org.kuali.rice.ken.service;
17
18 import java.util.Collection;
19
20 import org.kuali.rice.ken.bo.NotificationChannel;
21
22 /**
23 * Service for accessing {@link NotificationChannel}s
24 * @author Kuali Rice Team (rice.collab@kuali.org)
25 */
26 public interface NotificationChannelService {
27 /**
28 * This method returns all of the registered notification channels in the system.
29 * @return Collection
30 */
31 public Collection<NotificationChannel> getAllNotificationChannels();
32
33 /**
34 * This method retrieves a specific NotificationChannel instance by id. If none is found, it returns null.
35 * @param id
36 * @return NotificationChannel
37 */
38 public NotificationChannel getNotificationChannel(String id);
39
40 /**
41 * This method retrieves a specific NotificationChannel instance by name. If none is found, it returns null.
42 * @param id
43 * @return NotificationChannel
44 */
45 public NotificationChannel getNotificationChannelByName(String name);
46
47 /**
48 * This method retrieves all channels in the system that can be subscribed to.
49 * @return Collection
50 */
51 public Collection<NotificationChannel> getSubscribableChannels();
52 }