org.kuali.rice.ken.service
Interface UserPreferenceService

All Known Implementing Classes:

UserPreferenceServiceImpl

public interface UserPreferenceService

Service for accessing user preferences in the KEN system.UserPreference

Author:

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

Method Summary

Collection<UserChannelSubscription>	getCurrentSubscriptions(String userid) This method retrieves all of the current channel subscriptions for a user.
UserChannelSubscription	getSubscription(String channelid, String userid) This method retrieves the UserChannelSubscription instance given the two unique keys that are passed in.
void	subscribeToChannel(UserChannelSubscription userChannelSubscription) This method will add a channel subscription into the system.
void	unsubscribeFromChannel(UserChannelSubscription userChannelSubscription) This method will remove a channel subscription from the system.

Method Detail

getCurrentSubscriptions

Collection<UserChannelSubscription> getCurrentSubscriptions(String userid)

This method retrieves all of the current channel subscriptions for a user.

Parameters:

userid -

Returns:

Collection

getSubscription

UserChannelSubscription getSubscription(String channelid,
                                        String userid)

This method retrieves the UserChannelSubscription instance given the two unique keys that are passed in.

Parameters:

channelid -

userid -

Returns:

UserChannelSubscription

subscribeToChannel

void subscribeToChannel(UserChannelSubscription userChannelSubscription)

This method will add a channel subscription into the system.

Parameters:

userChannelSubscription -

unsubscribeFromChannel

void unsubscribeFromChannel(UserChannelSubscription userChannelSubscription)

This method will remove a channel subscription from the system.

Parameters:

userChannelSubscription -