1 /**
2 * Copyright 2005-2013 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.api.service;
17
18 import org.kuali.rice.core.api.exception.RiceIllegalArgumentException;
19
20 import java.util.Collection;
21
22 /**
23 * KEN API service internal to Rice, for use by KCB
24 *
25 * @author Kuali Rice Team (rice.collab@kuali.org)
26 */
27 public interface KENAPIService {
28 /**
29 * Returns names of all channels defined in KEN
30 * @return names of all channels defined in KEN
31 */
32 Collection<String> getAllChannelNames();
33
34 /**
35 * Returns the names of all deliverers the recipient has configured for a given channel
36 * @return the names of all deliverers the recipient has configured for a given channel
37 * @throws RiceIllegalArgumentException if the recipient, channel is null or blank.
38 */
39 Collection<String> getDeliverersForRecipientAndChannel(String recipient, String channel) throws RiceIllegalArgumentException;
40
41 /**
42 * Returns the specified recipient preference for the user
43 * @param recipient the recipient
44 * @param prefKey the preference key
45 * @return the specified recipient preference for the user
46 * @throws RiceIllegalArgumentException if the recipient, prefKey is null or blank
47 */
48 String getRecipientPreference(String recipient, String prefKey) throws RiceIllegalArgumentException;
49 }