org.jasig.portlet.announcements.service
Class PortletPreferencesTopicSubscriptionService

java.lang.Object
  org.jasig.portlet.announcements.service.PortletPreferencesTopicSubscriptionService

All Implemented Interfaces:

ITopicSubscriptionService

public class PortletPreferencesTopicSubscriptionService
extends Object
implements ITopicSubscriptionService

This implementation of ITopicSubscriptionService associates users with topics based on PortletProferences. These may have been established by the user, or (perhaps more importantly) may have been set by an admin at publish time. Whether configured by user or admin, this approach allows different topicsin different placements of the portlet.

Author:

awills

Field Summary

static String	PREFERENCE_TOPIC_WHITELIST Name for the PortletPreference listing topics that will appear in this portlet placement, provided the user is authorized.
static String	PREFERENCE_TOPICS_ADDED
static String	PREFERENCE_TOPICS_REMOVED
static String	UNAUTHENTICATED_USER

Constructor Summary

PortletPreferencesTopicSubscriptionService()

Method Summary

List<TopicSubscription>	getTopicSubscription(javax.portlet.RenderRequest req)
List<TopicSubscription>	getTopicSubscription(javax.portlet.RenderRequest req, boolean includeEmergency)
List<TopicSubscription>	getTopicSubscriptionEdit(javax.portlet.RenderRequest req)
void	setAnnouncementService(IAnnouncementService announcementService)

Methods inherited from class java.lang.Object

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

Field Detail

PREFERENCE_TOPIC_WHITELIST

public static final String PREFERENCE_TOPIC_WHITELIST

Name for the PortletPreference listing topics that will appear in this portlet placement, provided the user is authorized.

See Also:

Constant Field Values

PREFERENCE_TOPICS_ADDED

public static final String PREFERENCE_TOPICS_ADDED

See Also:

Constant Field Values

PREFERENCE_TOPICS_REMOVED

public static final String PREFERENCE_TOPICS_REMOVED

See Also:

Constant Field Values

UNAUTHENTICATED_USER

public static final String UNAUTHENTICATED_USER

See Also:

Constant Field Values

Constructor Detail

PortletPreferencesTopicSubscriptionService

public PortletPreferencesTopicSubscriptionService()

Method Detail

getTopicSubscription

public List<TopicSubscription> getTopicSubscription(javax.portlet.RenderRequest req,
                                                    boolean includeEmergency)
                                             throws javax.portlet.PortletException

Specified by:

getTopicSubscription in interface ITopicSubscriptionService

Throws:

javax.portlet.PortletException

getTopicSubscription

public List<TopicSubscription> getTopicSubscription(javax.portlet.RenderRequest req)
                                             throws javax.portlet.PortletException

Specified by:

getTopicSubscription in interface ITopicSubscriptionService

Throws:

javax.portlet.PortletException

getTopicSubscriptionEdit

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

Specified by:

getTopicSubscriptionEdit in interface ITopicSubscriptionService

Throws:

javax.portlet.PortletException

setAnnouncementService

public void setAnnouncementService(IAnnouncementService announcementService)