org.kuali.rice.ken.service
Interface NotificationChannelService

All Known Implementing Classes:

NotificationChannelServiceImpl

public interface NotificationChannelService

Service for accessing NotificationChannels

Author:

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

Method Summary

Collection<NotificationChannel>	getAllNotificationChannels() This method returns all of the registered notification channels in the system.
NotificationChannel	getNotificationChannel(String id) This method retrieves a specific NotificationChannel instance by id.
NotificationChannel	getNotificationChannelByName(String name) This method retrieves a specific NotificationChannel instance by name.
Collection<NotificationChannel>	getSubscribableChannels() This method retrieves all channels in the system that can be subscribed to.

Method Detail

getAllNotificationChannels

Collection<NotificationChannel> getAllNotificationChannels()

This method returns all of the registered notification channels in the system.

Returns:

Collection

getNotificationChannel

NotificationChannel getNotificationChannel(String id)

This method retrieves a specific NotificationChannel instance by id. If none is found, it returns null.

Parameters:

id -

Returns:

NotificationChannel

getNotificationChannelByName

NotificationChannel getNotificationChannelByName(String name)

This method retrieves a specific NotificationChannel instance by name. If none is found, it returns null.

Parameters:

id -

Returns:

NotificationChannel

getSubscribableChannels

Collection<NotificationChannel> getSubscribableChannels()

This method retrieves all channels in the system that can be subscribed to.

Returns:

Collection