Coverage Report

Coverage Report - org.kuali.rice.kcb.service.RecipientPreferenceService

Classes in this File

 /**
  * Copyright 2005-2011 The Kuali Foundation
  *
  * Licensed under the Educational Community License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
  *
  * http://www.opensource.org/licenses/ecl2.php
  *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
 package org.kuali.rice.kcb.service;
 
 import java.util.Collection;
 import java.util.HashMap;
 
 import org.kuali.rice.kcb.bo.RecipientDelivererConfig;
 import org.kuali.rice.kcb.bo.RecipientPreference;
 import org.kuali.rice.kcb.deliverer.MessageDeliverer;
 import org.kuali.rice.kcb.exception.ErrorList;
 
 /**
  * Service for accessing user preferences in the KEN system.{@link UserPreference}
  * @author Kuali Rice Team (rice.collab@kuali.org)
  */
 public interface RecipientPreferenceService {
     /**
      * This method will get all  user recipient preferences from the system.
      * @param recipientId
      */
     public HashMap<String, String> getRecipientPreferences(String recipientId);
 
     /**
      * This method will save a user recipient preferences in the system.
      * @param userid
      * @param prefs a hashmap of key/values
      * @param deliveryTypeName name of deliverer
      */
     public void saveRecipientPreferences(String userid, HashMap<String, String> prefs, MessageDeliverer deliverer) throws ErrorList;
     
     /**
      * This method will get a specific user recipient preferences from the system.
      * @param recipientId
      * @param key
      */
     public RecipientPreference getRecipientPreference(String recipientId, String key);
 
     /**
      * This method will save a specific user recipient preferences in the system.
      * @param pref the preferences
      */
     public void saveRecipientPreference(RecipientPreference pref);
     
     /**
      * This method will delete a specific user recipient preferences from the system.
      * @param pref the preferences
      */
     public void deleteRecipientPreference(RecipientPreference pref);
 
     // deliverer configuration
     
     /**
      * This method will remove all user deliverer configuration preferences in the system.
      * @param recipientId the recipient id
      */
     public void removeRecipientDelivererConfigs(String recipientId);
     
     /**
      * This method will save a user deliverer configuration preferences in the system.
      * @param recipientId the recipient id
      * @param delivererName the deliverer name
      * @param channels the channels for which to enable the deliverer
      */
     public void saveRecipientDelivererConfig(String recipientId, String delivererName, String[] channels);
 
     /**
      * This method will retrieve all of the message deliverer configurations for a given user, associated with a 
      * particular channel.
      * @param recipientId
      * @param channel
      */
     public Collection<RecipientDelivererConfig> getDeliverersForRecipientAndChannel(String recipientId, String channel);
     
     /**
      * This method will retrieve all of the message deliverer configurations for a given user 
      * @param recipientId
      */
     public Collection<RecipientDelivererConfig> getDeliverersForRecipient(String recipientId);
 }

1		/**
2		* Copyright 2005-2011 The Kuali Foundation
3		*
4		* Licensed under the Educational Community License, Version 2.0 (the "License");
5		* you may not use this file except in compliance with the License.
6		* You may obtain a copy of the License at
7		*
8		* http://www.opensource.org/licenses/ecl2.php
9		*
10		* Unless required by applicable law or agreed to in writing, software
11		* distributed under the License is distributed on an "AS IS" BASIS,
12		* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13		* See the License for the specific language governing permissions and
14		* limitations under the License.
15		*/
16		package org.kuali.rice.kcb.service;
17
18		import java.util.Collection;
19		import java.util.HashMap;
20
21		import org.kuali.rice.kcb.bo.RecipientDelivererConfig;
22		import org.kuali.rice.kcb.bo.RecipientPreference;
23		import org.kuali.rice.kcb.deliverer.MessageDeliverer;
24		import org.kuali.rice.kcb.exception.ErrorList;
25
26		/**
27		* Service for accessing user preferences in the KEN system.{@link UserPreference}
28		* @author Kuali Rice Team (rice.collab@kuali.org)
29		*/
30		public interface RecipientPreferenceService {
31		/**
32		* This method will get all user recipient preferences from the system.
33		* @param recipientId
34		*/
35		public HashMap<String, String> getRecipientPreferences(String recipientId);
36
37		/**
38		* This method will save a user recipient preferences in the system.
39		* @param userid
40		* @param prefs a hashmap of key/values
41		* @param deliveryTypeName name of deliverer
42		*/
43		public void saveRecipientPreferences(String userid, HashMap<String, String> prefs, MessageDeliverer deliverer) throws ErrorList;
44
45		/**
46		* This method will get a specific user recipient preferences from the system.
47		* @param recipientId
48		* @param key
49		*/
50		public RecipientPreference getRecipientPreference(String recipientId, String key);
51
52		/**
53		* This method will save a specific user recipient preferences in the system.
54		* @param pref the preferences
55		*/
56		public void saveRecipientPreference(RecipientPreference pref);
57
58		/**
59		* This method will delete a specific user recipient preferences from the system.
60		* @param pref the preferences
61		*/
62		public void deleteRecipientPreference(RecipientPreference pref);
63
64		// deliverer configuration
65
66		/**
67		* This method will remove all user deliverer configuration preferences in the system.
68		* @param recipientId the recipient id
69		*/
70		public void removeRecipientDelivererConfigs(String recipientId);
71
72		/**
73		* This method will save a user deliverer configuration preferences in the system.
74		* @param recipientId the recipient id
75		* @param delivererName the deliverer name
76		* @param channels the channels for which to enable the deliverer
77		*/
78		public void saveRecipientDelivererConfig(String recipientId, String delivererName, String[] channels);
79
80		/**
81		* This method will retrieve all of the message deliverer configurations for a given user, associated with a
82		* particular channel.
83		* @param recipientId
84		* @param channel
85		*/
86		public Collection<RecipientDelivererConfig> getDeliverersForRecipientAndChannel(String recipientId, String channel);
87
88		/**
89		* This method will retrieve all of the message deliverer configurations for a given user
90		* @param recipientId
91		*/
92		public Collection<RecipientDelivererConfig> getDeliverersForRecipient(String recipientId);
93		}