org.jasig.portlet.announcements.service

Interface ITopicSubscriptionService

All Known Implementing Classes:

UserConfiguredTopicSubscriptionService

public interface ITopicSubscriptionService

Implementations of this interface tell the controller(s) which topic(s) will be displayed in the portlet for the specified user, and for enforcing restrictions on those topics established by administrators.

Version:

$Id: $Id

Author:

awills

Method Summary

Modifier and Type	Method and Description
List<TopicSubscription>	getTopicSubscription(javax.portlet.PortletRequest request) getTopicSubscription.
List<TopicSubscription>	getTopicSubscription(javax.portlet.PortletRequest request, boolean includeEmergency) getTopicSubscription.
List<TopicSubscription>	getTopicSubscriptionEdit(javax.portlet.RenderRequest request) getTopicSubscriptionEdit.

Method Detail

getTopicSubscription

List<TopicSubscription> getTopicSubscription(javax.portlet.PortletRequest request,
                                             boolean includeEmergency)
                                      throws javax.portlet.PortletException

getTopicSubscription.

Parameters:

request - a PortletRequest object.

includeEmergency - a boolean.

Returns:

a List object.

Throws:

javax.portlet.PortletException - if any.

getTopicSubscriptionEdit

List<TopicSubscription> getTopicSubscriptionEdit(javax.portlet.RenderRequest request)
                                          throws javax.portlet.PortletException

getTopicSubscriptionEdit.

Parameters:

request - a RenderRequest object.

Returns:

a List object.

Throws:

javax.portlet.PortletException - if any.

getTopicSubscription

List<TopicSubscription> getTopicSubscription(javax.portlet.PortletRequest request)
                                      throws javax.portlet.PortletException

getTopicSubscription.

Parameters:

request - a PortletRequest object.

Returns:

a List object.

Throws:

javax.portlet.PortletException - if any.