org.kuali.rice.kcb.service

Interface MessageDelivererRegistryService

All Superinterfaces:

MessageDelivererRegistryAPI

All Known Implementing Classes:

MessageDelivererRegistryServiceImpl

public interface MessageDelivererRegistryService
extends MessageDelivererRegistryAPI

This class is responsible for providing services for Message Deliverers (delivery types)

Author:

Kuali Rice Team (rice.collab@kuali.org)

Method Summary

Methods

Modifier and Type	Method and Description
Collection<MessageDeliverer>	getAllDeliverers() This service method is responsible for retrieving all MessageDeliverer Types.
Collection<String>	getAllDelivererTypes() This service method is responsible for retrieving all MessageDeliverer Types names.
MessageDeliverer	getDeliverer(MessageDelivery messageDelivery) This method returns the associated deliverer class instance for the given MessageDelivery instance.
MessageDeliverer	getDelivererByName(String messageDelivererName) This method returns the associated deliverer class instance for the given deliverer name.

Method Detail

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 MessageDelivererRegistryAPI

Returns:

Collection of deliverer type names

getDeliverer

MessageDeliverer getDeliverer(MessageDelivery messageDelivery)
                              throws RiceIllegalArgumentException

This method returns the associated deliverer class instance for the given MessageDelivery instance.

Parameters:

messageDelivery -

Returns:

MessageDeliverer or null if not found

Throws:

RiceIllegalArgumentException - if messageDelivery is null

getDelivererByName

MessageDeliverer getDelivererByName(String messageDelivererName)
                                    throws RiceIllegalArgumentException

This method returns the associated deliverer class instance for the given deliverer name.

Parameters:

messageDelivererName -

Returns:

MessageDeliverer or null if not found

Throws:

RiceIllegalArgumentException - if messageDelivererName is null