org.kuali.rice.kcb.service.impl
Class RecipientPreferenceServiceImpl

java.lang.Object
  org.kuali.rice.kcb.service.impl.BusinessObjectServiceImpl
      org.kuali.rice.kcb.service.impl.RecipientPreferenceServiceImpl

All Implemented Interfaces:

RecipientPreferenceService

public class RecipientPreferenceServiceImpl
extends BusinessObjectServiceImpl
implements RecipientPreferenceService

RecipientPreferenceService implementation

Author:

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

Field Summary

Fields inherited from class org.kuali.rice.kcb.service.impl.BusinessObjectServiceImpl

dao

Constructor Summary

RecipientPreferenceServiceImpl()

Method Summary

void	deleteRecipientPreference(RecipientPreference pref) This method will delete a specific user recipient preference 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 preference from the system.
HashMap<String,String>	getRecipientPreferences(String recipientId) This method will get all user recipient preference from the system.
void	removeRecipientDelivererConfigs(String recipientId) This method will remove all user deliverer configuration preference in the system.
void	saveRecipientDelivererConfig(String recipientId, String delivererName, String[] channels) This method will save a user deliverer configuration preference in the system.
void	saveRecipientPreference(RecipientPreference pref) This method will save a specific user recipient preference in the system.
void	saveRecipientPreferences(String recipientId, HashMap<String,String> prefs, MessageDeliverer deliverer) This method will save a user recipient preference in the system.

Methods inherited from class org.kuali.rice.kcb.service.impl.BusinessObjectServiceImpl

setGenericDao

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RecipientPreferenceServiceImpl

public RecipientPreferenceServiceImpl()

Method Detail

getRecipientPreference

public RecipientPreference getRecipientPreference(String recipientId,
                                                  String key)

Description copied from interface: RecipientPreferenceService

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

Specified by:

getRecipientPreference in interface RecipientPreferenceService

See Also:

RecipientPreferenceService.getRecipientPreference(java.lang.String, java.lang.String)

deleteRecipientPreference

public void deleteRecipientPreference(RecipientPreference pref)

Description copied from interface: RecipientPreferenceService

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

Specified by:

deleteRecipientPreference in interface RecipientPreferenceService

Parameters:

pref - the preference

See Also:

RecipientPreferenceService.deleteRecipientPreference(org.kuali.rice.kcb.bo.RecipientPreference)

getRecipientPreferences

public HashMap<String,String> getRecipientPreferences(String recipientId)

Description copied from interface: RecipientPreferenceService

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

Specified by:

getRecipientPreferences in interface RecipientPreferenceService

See Also:

RecipientPreferenceService.getRecipientPreferences(java.lang.String)

saveRecipientPreference

public void saveRecipientPreference(RecipientPreference pref)

Description copied from interface: RecipientPreferenceService

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

Specified by:

saveRecipientPreference in interface RecipientPreferenceService

Parameters:

pref - the preference

See Also:

RecipientPreferenceService.saveRecipientPreference(org.kuali.rice.kcb.bo.RecipientPreference)

saveRecipientPreferences

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

Description copied from interface: RecipientPreferenceService

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

Specified by:

saveRecipientPreferences in interface RecipientPreferenceService

prefs - a hashmap of key/values

Throws:

ErrorList

See Also:

RecipientPreferenceService.saveRecipientPreferences(java.lang.String, java.util.HashMap, org.kuali.rice.kcb.deliverer.MessageDeliverer)

removeRecipientDelivererConfigs

public void removeRecipientDelivererConfigs(String recipientId)

Description copied from interface: RecipientPreferenceService

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

Specified by:

removeRecipientDelivererConfigs in interface RecipientPreferenceService

Parameters:

recipientId - the recipient id

See Also:

RecipientPreferenceService.removeRecipientDelivererConfigs(java.lang.String)

saveRecipientDelivererConfig

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

Description copied from interface: RecipientPreferenceService

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

Specified by:

saveRecipientDelivererConfig in interface RecipientPreferenceService

Parameters:

recipientId - the recipient id

delivererName - the deliverer name

channels - the channels for which to enable the deliverer

See Also:

RecipientPreferenceService.saveRecipientDelivererConfig(java.lang.String, java.lang.String, java.lang.String[])

getDeliverersForRecipient

public Collection<RecipientDelivererConfig> getDeliverersForRecipient(String recipientId)

Description copied from interface: RecipientPreferenceService

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

Specified by:

getDeliverersForRecipient in interface RecipientPreferenceService

See Also:

RecipientPreferenceService.getDeliverersForRecipient(java.lang.String)

getDeliverersForRecipientAndChannel

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

Description copied from interface: RecipientPreferenceService

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

Specified by:

getDeliverersForRecipientAndChannel in interface RecipientPreferenceService

See Also:

RecipientPreferenceService.getDeliverersForRecipientAndChannel(java.lang.String, java.lang.String)