001/**
002 * Copyright 2005-2017 The Kuali Foundation
003 *
004 * Licensed under the Educational Community License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 * http://www.opensource.org/licenses/ecl2.php
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016package org.kuali.rice.ken.service;
017
018import java.util.Collection;
019
020import org.kuali.rice.ken.bo.UserChannelSubscriptionBo;
021
022/**
023 * Service for accessing user preferences in the KEN system.{@link UserPreference}
024 * @author Kuali Rice Team (rice.collab@kuali.org)
025 */
026public interface UserPreferenceService {
027    /**
028     * This method retrieves all of the current channel subscriptions for a user.
029     * @param userid
030     * @return Collection
031     */
032    public Collection<UserChannelSubscriptionBo> getCurrentSubscriptions(String userid);
033    
034    /**
035     * This method retrieves the UserChannelSubscription instance given the two unique keys that are 
036     * passed in.
037     * @param channelid
038     * @param userid
039     * @return UserChannelSubscription
040     */
041    public UserChannelSubscriptionBo getSubscription(String channelid, String userid);
042
043    /**
044     * This method will add a channel subscription into the system.
045     * @param userChannelSubscription
046     */
047    public void subscribeToChannel(UserChannelSubscriptionBo userChannelSubscription);
048
049    /**
050     * This method will remove a channel subscription from the system.
051     * @param userChannelSubscription
052     */
053    public void unsubscribeFromChannel(UserChannelSubscriptionBo userChannelSubscription);
054}