org.jasig.portlet.announcements.controller

Class AnnouncementsViewController

java.lang.Object

org.jasig.portlet.announcements.controller.AnnouncementsViewController

All Implemented Interfaces:

org.springframework.beans.factory.InitializingBean

@Controller
 @RequestMapping(value="VIEW")
public class AnnouncementsViewController
extends Object
implements org.springframework.beans.factory.InitializingBean

Author:

eolsson

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_SORT_STRATEGY
static String	NOTIFICATION_NAMESPACE
static String	NOTIFICATION_QUERY_LOCAL_NAME
static QName	NOTIFICATION_QUERY_QNAME
static String	NOTIFICATION_QUERY_QNAME_STRING
static String	NOTIFICATION_RESULT_LOCAL_NAME
static QName	NOTIFICATION_RESULT_QNAME
static String	NOTIFICATION_RESULT_QNAME_STRING
static String	PREFERENCE_DISABLE_EDIT
static String	PREFERENCE_DISPLAY_STARTDATE
static String	PREFERENCE_HIDE_ABSTRACT
static String	PREFERENCE_PAGE_SIZE
static String	PREFERENCE_SCROLLING_DISPLAY_HEIGHT_PIXELS
static String	PREFERENCE_SORT_STRATEGY
static String	PREFERENCE_SYNDICATE_TOPICS_ANNOUNCEMENTS_DISPLAY_FNAME
static String	PREFERENCE_SYNDICATE_TOPICS_AS_NOTIFICATIONS
static String	PREFERENCE_USE_SCROLLING_DISPLAY

Constructor Summary

Constructors

Constructor and Description
AnnouncementsViewController()

Method Summary

Modifier and Type	Method and Description
void	afterPropertiesSet()
String	displayFullAnnouncement(org.springframework.ui.Model model, javax.portlet.RenderRequest request, String announcementId)
String	displayFullAnnouncementHistory(org.springframework.ui.Model model, javax.portlet.RenderRequest request, String announcementId)
String	displayHistory(org.springframework.ui.Model model, javax.portlet.RenderRequest request)
boolean	getDisplayPublishDate(javax.portlet.PortletRequest req)
int	getPageSize(javax.portlet.PortletRequest req)
int	getScrollingDisplayHeightPixels(javax.portlet.PortletRequest req)
boolean	getUseScrollingDisplay(javax.portlet.PortletRequest req)
boolean	isGuest(javax.portlet.PortletRequest req)
String	mainView(org.springframework.ui.Model model, javax.portlet.RenderRequest request, Integer from, Integer to) Main method of this display controller.
void	setCm(org.springframework.cache.ehcache.EhCacheCacheManager cm)
void	setTss(ITopicSubscriptionService tss)
void	syndicateAnnouncementsAsNotifications(javax.portlet.EventRequest req, javax.portlet.EventResponse res)

Methods inherited from class java.lang.Object

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

Field Detail

PREFERENCE_DISPLAY_STARTDATE

public static final String PREFERENCE_DISPLAY_STARTDATE

See Also:

Constant Field Values

PREFERENCE_DISABLE_EDIT

public static final String PREFERENCE_DISABLE_EDIT

See Also:

Constant Field Values

PREFERENCE_PAGE_SIZE

public static final String PREFERENCE_PAGE_SIZE

See Also:

Constant Field Values

PREFERENCE_SORT_STRATEGY

public static final String PREFERENCE_SORT_STRATEGY

See Also:

Constant Field Values

PREFERENCE_USE_SCROLLING_DISPLAY

public static final String PREFERENCE_USE_SCROLLING_DISPLAY

See Also:

Constant Field Values

PREFERENCE_SCROLLING_DISPLAY_HEIGHT_PIXELS

public static final String PREFERENCE_SCROLLING_DISPLAY_HEIGHT_PIXELS

See Also:

Constant Field Values

PREFERENCE_HIDE_ABSTRACT

public static final String PREFERENCE_HIDE_ABSTRACT

See Also:

Constant Field Values

PREFERENCE_SYNDICATE_TOPICS_AS_NOTIFICATIONS

public static final String PREFERENCE_SYNDICATE_TOPICS_AS_NOTIFICATIONS

See Also:

Constant Field Values

PREFERENCE_SYNDICATE_TOPICS_ANNOUNCEMENTS_DISPLAY_FNAME

public static final String PREFERENCE_SYNDICATE_TOPICS_ANNOUNCEMENTS_DISPLAY_FNAME

See Also:

Constant Field Values

DEFAULT_SORT_STRATEGY

public static final String DEFAULT_SORT_STRATEGY

See Also:

Constant Field Values

NOTIFICATION_NAMESPACE

public static final String NOTIFICATION_NAMESPACE

See Also:

Constant Field Values

NOTIFICATION_QUERY_LOCAL_NAME

public static final String NOTIFICATION_QUERY_LOCAL_NAME

See Also:

Constant Field Values

NOTIFICATION_QUERY_QNAME

public static final QName NOTIFICATION_QUERY_QNAME

NOTIFICATION_QUERY_QNAME_STRING

public static final String NOTIFICATION_QUERY_QNAME_STRING

See Also:

Constant Field Values

NOTIFICATION_RESULT_LOCAL_NAME

public static final String NOTIFICATION_RESULT_LOCAL_NAME

See Also:

Constant Field Values

NOTIFICATION_RESULT_QNAME

public static final QName NOTIFICATION_RESULT_QNAME

NOTIFICATION_RESULT_QNAME_STRING

public static final String NOTIFICATION_RESULT_QNAME_STRING

See Also:

Constant Field Values

Constructor Detail

AnnouncementsViewController

public AnnouncementsViewController()

Method Detail

mainView

@RenderMapping
public String mainView(org.springframework.ui.Model model,
                                      javax.portlet.RenderRequest request,
                                      @RequestParam(value="from",required=false)
                                      Integer from,
                                      @RequestParam(value="to",required=false)
                                      Integer to)
                               throws javax.portlet.PortletException

Main method of this display controller. Calculates which topics should be shown to this user and which announcements to show from those topics.

Parameters:

model -

request -

from -

Returns:

Throws:

javax.portlet.PortletException

displayFullAnnouncement

@RenderMapping(params="action=displayFullAnnouncement")
public String displayFullAnnouncement(org.springframework.ui.Model model,
                                                                                              javax.portlet.RenderRequest request,
                                                                                              @RequestParam(value="announcementId")
                                                                                              String announcementId)
                                                                                       throws Exception

Throws:

Exception

syndicateAnnouncementsAsNotifications

@EventMapping(value="{https://source.jasig.org/schemas/portlet/notification}NotificationQuery")
public void syndicateAnnouncementsAsNotifications(javax.portlet.EventRequest req,
                                                                                                                                                  javax.portlet.EventResponse res)
                                                                                                                                           throws javax.portlet.PortletException

Throws:

javax.portlet.PortletException

getDisplayPublishDate

@ModelAttribute(value="displayPublishDate")
public boolean getDisplayPublishDate(javax.portlet.PortletRequest req)

setTss

public void setTss(ITopicSubscriptionService tss)

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Throws:

Exception

setCm

public void setCm(org.springframework.cache.ehcache.EhCacheCacheManager cm)

displayFullAnnouncementHistory

@RenderMapping(params="action=displayFullAnnouncementHistory")
public String displayFullAnnouncementHistory(org.springframework.ui.Model model,
                                                                                                            javax.portlet.RenderRequest request,
                                                                                                            @RequestParam(value="announcementId")
                                                                                                            String announcementId)
                                                                                                     throws Exception

Throws:

Exception

displayHistory

@RenderMapping(params="action=displayHistory")
public String displayHistory(org.springframework.ui.Model model,
                                                                            javax.portlet.RenderRequest request)
                                                                     throws Exception

Throws:

Exception

getPageSize

@ModelAttribute(value="increment")
public int getPageSize(javax.portlet.PortletRequest req)

isGuest

@ModelAttribute(value="isGuest")
public boolean isGuest(javax.portlet.PortletRequest req)

getUseScrollingDisplay

@ModelAttribute(value="useScrollingDisplay")
public boolean getUseScrollingDisplay(javax.portlet.PortletRequest req)

getScrollingDisplayHeightPixels

@ModelAttribute(value="scrollingDisplayHeightPixels")
public int getScrollingDisplayHeightPixels(javax.portlet.PortletRequest req)