| Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
| MessageDelivererRegistryService |
|
| 1.0;1 |
| 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.kcb.service; | |
| 17 | ||
| 18 | import java.util.Collection; | |
| 19 | ||
| 20 | import org.kuali.rice.core.api.exception.RiceIllegalArgumentException; | |
| 21 | import org.kuali.rice.kcb.api.service.MessageDelivererRegistryAPI; | |
| 22 | import org.kuali.rice.kcb.bo.MessageDelivery; | |
| 23 | import org.kuali.rice.kcb.deliverer.MessageDeliverer; | |
| 24 | ||
| 25 | /** | |
| 26 | * This class is responsible for providing services for Message Deliverers (delivery types) | |
| 27 | * @author Kuali Rice Team (rice.collab@kuali.org) | |
| 28 | */ | |
| 29 | public interface MessageDelivererRegistryService extends MessageDelivererRegistryAPI { | |
| 30 | /** | |
| 31 | * This service method is responsible for retrieving all MessageDeliverer Types. | |
| 32 | * @return Collection of MessageDeliverer objects | |
| 33 | */ | |
| 34 | Collection<MessageDeliverer> getAllDeliverers(); | |
| 35 | ||
| 36 | /** | |
| 37 | * This service method is responsible for retrieving all MessageDeliverer Types names. | |
| 38 | * @return Collection of deliverer type names | |
| 39 | */ | |
| 40 | Collection<String> getAllDelivererTypes(); | |
| 41 | ||
| 42 | /** | |
| 43 | * This method returns the associated deliverer class instance for the given MessageDelivery instance. | |
| 44 | * @param messageDelivery | |
| 45 | * @return MessageDeliverer or null if not found | |
| 46 | */ | |
| 47 | MessageDeliverer getDeliverer(MessageDelivery messageDelivery) throws RiceIllegalArgumentException; | |
| 48 | ||
| 49 | /** | |
| 50 | * This method returns the associated deliverer class instance for the given deliverer name. | |
| 51 | * @param messageDelivererName | |
| 52 | * @return MessageDeliverer or null if not found | |
| 53 | */ | |
| 54 | MessageDeliverer getDelivererByName(String messageDelivererName) throws RiceIllegalArgumentException; | |
| 55 | } |