org.kuali.rice.ken.api.service

Interface KENAPIService

All Known Implementing Classes:

KENAPIServiceImpl

public interface KENAPIService

KEN API service internal to Rice, for use by KCB

Author:

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

Method Summary

Methods

Modifier and Type	Method and Description
Collection<String>	getAllChannelNames() Returns names of all channels defined in KEN
Collection<String>	getDeliverersForRecipientAndChannel(String recipient, String channel) Returns the names of all deliverers the recipient has configured for a given channel
String	getRecipientPreference(String recipient, String prefKey) Returns the specified recipient preference for the user

Method Detail

getAllChannelNames

Collection<String> getAllChannelNames()

Returns names of all channels defined in KEN

Returns:

names of all channels defined in KEN

getDeliverersForRecipientAndChannel

Collection<String> getDeliverersForRecipientAndChannel(String recipient,
                                                     String channel)
                                                       throws RiceIllegalArgumentException

Returns the names of all deliverers the recipient has configured for a given channel

Returns:

the names of all deliverers the recipient has configured for a given channel

Throws:

RiceIllegalArgumentException - if the recipient, channel is null or blank.

getRecipientPreference

String getRecipientPreference(String recipient,
                            String prefKey)
                              throws RiceIllegalArgumentException

Returns the specified recipient preference for the user

Parameters:

recipient - the recipient

prefKey - the preference key

Returns:

the specified recipient preference for the user

Throws:

RiceIllegalArgumentException - if the recipient, prefKey is null or blank