| Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
| KENAPIService |
|
| 1.0;1 |
| 1 | /* | |
| 2 | * Copyright 2007-2008 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 | /** | |
| 21 | * KEN API service internal to Rice, for use by KCB | |
| 22 | * | |
| 23 | * @author Kuali Rice Team (rice.collab@kuali.org) | |
| 24 | */ | |
| 25 | public interface KENAPIService { | |
| 26 | /** | |
| 27 | * Returns names of all channels defined in KEN | |
| 28 | * @return names of all channels defined in KEN | |
| 29 | */ | |
| 30 | Collection<String> getAllChannelNames(); | |
| 31 | ||
| 32 | /** | |
| 33 | * Returns the names of all deliverers the recipient has configured for a given channel | |
| 34 | * @return the names of all deliverers the recipient has configured for a given channel | |
| 35 | */ | |
| 36 | Collection<String> getDeliverersForRecipientAndChannel(String recipient, String channel); | |
| 37 | ||
| 38 | /** | |
| 39 | * Returns the specified recipient preference for the user | |
| 40 | * @param recipient the recipient | |
| 41 | * @param prefKey the preference key | |
| 42 | * @return the specified recipient preference for the user | |
| 43 | */ | |
| 44 | String getRecipientPreference(String recipient, String prefKey); | |
| 45 | } |