org.kuali.rice.kcb.service
Interface RecipientPreferenceService

All Known Implementing Classes:

RecipientPreferenceServiceImpl

public interface RecipientPreferenceService

Service for accessing user preferences in the KEN system.UserPreference

Author:

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

Method Summary

void	deleteRecipientPreference(RecipientPreference pref) This method will delete a specific user recipient preferences from the system.
Collection<RecipientDelivererConfig>	getDeliverersForRecipient(String recipientId) This method will retrieve all of the message deliverer configurations for a given user
Collection<RecipientDelivererConfig>	getDeliverersForRecipientAndChannel(String recipientId, String channel) This method will retrieve all of the message deliverer configurations for a given user, associated with a particular channel.
RecipientPreference	getRecipientPreference(String recipientId, String key) This method will get a specific user recipient preferences from the system.
HashMap<String,String>	getRecipientPreferences(String recipientId) This method will get all user recipient preferences from the system.
void	removeRecipientDelivererConfigs(String recipientId) This method will remove all user deliverer configuration preferences in the system.
void	saveRecipientDelivererConfig(String recipientId, String delivererName, String[] channels) This method will save a user deliverer configuration preferences in the system.
RecipientPreference	saveRecipientPreference(RecipientPreference pref) This method will save a specific user recipient preferences in the system.
void	saveRecipientPreferences(String userid, HashMap<String,String> prefs, MessageDeliverer deliverer) This method will save a user recipient preferences in the system.

Method Detail

getRecipientPreferences

HashMap<String,String> getRecipientPreferences(String recipientId)

This method will get all user recipient preferences from the system.

Parameters:

recipientId -

saveRecipientPreferences

void saveRecipientPreferences(String userid,
                              HashMap<String,String> prefs,
                              MessageDeliverer deliverer)
                              throws ErrorList

This method will save a user recipient preferences in the system.

Parameters:

userid -

prefs - a hashmap of key/values

deliveryTypeName - name of deliverer

Throws:

ErrorList

getRecipientPreference

RecipientPreference getRecipientPreference(String recipientId,
                                           String key)

This method will get a specific user recipient preferences from the system.

Parameters:

recipientId -

key -

saveRecipientPreference

RecipientPreference saveRecipientPreference(RecipientPreference pref)

This method will save a specific user recipient preferences in the system.

Parameters:

pref - the preferences

deleteRecipientPreference

void deleteRecipientPreference(RecipientPreference pref)

This method will delete a specific user recipient preferences from the system.

Parameters:

pref - the preferences

removeRecipientDelivererConfigs

void removeRecipientDelivererConfigs(String recipientId)

This method will remove all user deliverer configuration preferences in the system.

Parameters:

recipientId - the recipient id

saveRecipientDelivererConfig

void saveRecipientDelivererConfig(String recipientId,
                                  String delivererName,
                                  String[] channels)

This method will save a user deliverer configuration preferences in the system.

Parameters:

recipientId - the recipient id

delivererName - the deliverer name

channels - the channels for which to enable the deliverer

getDeliverersForRecipientAndChannel

Collection<RecipientDelivererConfig> getDeliverersForRecipientAndChannel(String recipientId,
                                                                         String channel)

This method will retrieve all of the message deliverer configurations for a given user, associated with a particular channel.

Parameters:

recipientId -

channel -

getDeliverersForRecipient

Collection<RecipientDelivererConfig> getDeliverersForRecipient(String recipientId)

This method will retrieve all of the message deliverer configurations for a given user

Parameters:

recipientId -