Package org.kuali.rice.kcb.service

Interface MessageDelivererRegistryService

All Superinterfaces:
org.kuali.rice.kcb.api.service.MessageDelivererRegistryAPI
All Known Implementing Classes:
MessageDelivererRegistryServiceImpl
public interface MessageDelivererRegistryService extends org.kuali.rice.kcb.api.service.MessageDelivererRegistryAPI
This class is responsible for providing services for Message Deliverers (delivery types)
Author:
Kuali Rice Team (rice.collab@kuali.org)

  • Method Details

    • getAllDeliverers

      Collection<MessageDeliverer> getAllDeliverers()
      This service method is responsible for retrieving all MessageDeliverer Types.
      Returns:
      Collection of MessageDeliverer objects

    • getAllDelivererTypes

      Collection<String> getAllDelivererTypes()
      This service method is responsible for retrieving all MessageDeliverer Types names.
      Specified by:
      getAllDelivererTypes in interface org.kuali.rice.kcb.api.service.MessageDelivererRegistryAPI
      Returns:
      Collection of deliverer type names

    • getDeliverer

      MessageDeliverer getDeliverer(MessageDelivery messageDelivery) throws org.kuali.rice.core.api.exception.RiceIllegalArgumentException
      This method returns the associated deliverer class instance for the given MessageDelivery instance.
      Parameters:
      messageDelivery -
      Returns:
      MessageDeliverer or null if not found
      Throws:
      org.kuali.rice.core.api.exception.RiceIllegalArgumentException - if messageDelivery is null

    • getDelivererByName

      MessageDeliverer getDelivererByName(String messageDelivererName) throws org.kuali.rice.core.api.exception.RiceIllegalArgumentException
      This method returns the associated deliverer class instance for the given deliverer name.
      Parameters:
      messageDelivererName -
      Returns:
      MessageDeliverer or null if not found
      Throws:
      org.kuali.rice.core.api.exception.RiceIllegalArgumentException - if messageDelivererName is null