org.jasig.portlet.announcements.mvc.portlet.display

Class AnnouncementsViewController

java.lang.Object

org.jasig.portlet.announcements.mvc.portlet.display.AnnouncementsViewController

@Controller
 @RequestMapping(value="VIEW")
public class AnnouncementsViewController
extends Object

AnnouncementsViewController class.

Version:

$Id: $Id

Author:

Unknown

Field Summary

Fields

Modifier and Type	Field and Description
static String	ACTION_DISPLAY_FULL_ANNOUNCEMENT Constant ACTION_DISPLAY_FULL_ANNOUNCEMENT="displayFullAnnouncement"
static String	DEFAULT_SORT_STRATEGY Constant DEFAULT_SORT_STRATEGY="START_DISPLAY_DATE_ASCENDING"
static String	NOTIFICATION_NAMESPACE Constant NOTIFICATION_NAMESPACE="https://source.jasig.org/schemas/portle"{trunked}
static String	NOTIFICATION_QUERY_LOCAL_NAME Constant NOTIFICATION_QUERY_LOCAL_NAME="NotificationQuery"
static QName	NOTIFICATION_QUERY_QNAME Constant NOTIFICATION_QUERY_QNAME
static String	NOTIFICATION_QUERY_QNAME_STRING Constant NOTIFICATION_QUERY_QNAME_STRING="{ + NOTIFICATION_NAMESPACE + } + NOTIFI"{trunked}
static String	NOTIFICATION_RESULT_LOCAL_NAME Constant NOTIFICATION_RESULT_LOCAL_NAME="NotificationResult"
static QName	NOTIFICATION_RESULT_QNAME Constant NOTIFICATION_RESULT_QNAME
static String	NOTIFICATION_RESULT_QNAME_STRING Constant NOTIFICATION_RESULT_QNAME_STRING="{ + NOTIFICATION_NAMESPACE + } + NOTIFI"{trunked}
static String	PREFERENCE_DISABLE_EDIT Constant PREFERENCE_DISABLE_EDIT="AnnouncementsViewController.PREFERENCE_"{trunked}
static String	PREFERENCE_DISPLAY_STARTDATE Constant PREFERENCE_DISPLAY_STARTDATE="AnnouncementsViewController.displayPubl"{trunked}
static String	PREFERENCE_HIDE_ABSTRACT Constant PREFERENCE_HIDE_ABSTRACT="AnnouncementsViewController.hideAbstrac"{trunked}
static String	PREFERENCE_PAGE_SIZE Constant PREFERENCE_PAGE_SIZE="AnnouncementsViewController.PAGE_SIZE"
static String	PREFERENCE_SCROLLING_DISPLAY_HEIGHT_PIXELS Constant PREFERENCE_SCROLLING_DISPLAY_HEIGHT_PIXELS="AnnouncementsViewController.scrollingDi"{trunked}
static String	PREFERENCE_SORT_STRATEGY Constant PREFERENCE_SORT_STRATEGY="AnnouncementsViewController.Announcemen"{trunked}
static String	PREFERENCE_SYNDICATE_TOPICS_ANNOUNCEMENTS_DISPLAY_FNAME Constant PREFERENCE_SYNDICATE_TOPICS_ANNOUNCEMENTS_DISPLAY_FNAME="AnnouncementsViewController.syndicateTo"{trunked}
static String	PREFERENCE_SYNDICATE_TOPICS_AS_NOTIFICATIONS Constant PREFERENCE_SYNDICATE_TOPICS_AS_NOTIFICATIONS="AnnouncementsViewController.syndicateTo"{trunked}
static String	PREFERENCE_USE_SCROLLING_DISPLAY Constant PREFERENCE_USE_SCROLLING_DISPLAY="AnnouncementsViewController.useScrollin"{trunked}
static String	TOPICS_CACHE Constant TOPICS_CACHE="topicLists"
static String	USER_TOPICS_CACHE Constant USER_TOPICS_CACHE="userTopicLists"

Constructor Summary

Constructors

Constructor and Description
AnnouncementsViewController()

Method Summary

Modifier and Type	Method and Description
void	announcementsResource(javax.portlet.ResourceRequest request, javax.portlet.ResourceResponse response) announcementsResource.
String	displayFullAnnouncement(org.springframework.ui.Model model, javax.portlet.RenderRequest request, String announcementId) displayFullAnnouncement.
String	displayFullAnnouncementHistory(org.springframework.ui.Model model, javax.portlet.RenderRequest request, String announcementId) displayFullAnnouncementHistory.
String	displayHistory(org.springframework.ui.Model model, javax.portlet.RenderRequest request) displayHistory.
void	emergenciesResource(javax.portlet.ResourceRequest request, javax.portlet.ResourceResponse response) emergenciesResource.
boolean	getDisplayPublishDate(javax.portlet.PortletRequest req) getDisplayPublishDate.
int	getPageSize(javax.portlet.PortletRequest req) getPageSize.
int	getScrollingDisplayHeightPixels(javax.portlet.PortletRequest req) getScrollingDisplayHeightPixels.
boolean	getUseScrollingDisplay(javax.portlet.PortletRequest req) getUseScrollingDisplay.
boolean	isGuest(javax.portlet.PortletRequest req) isGuest.
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) Setter for the field cm.
void	setTss(ITopicSubscriptionService tss) Setter for the field tss.
void	syndicateAnnouncementsAsNotifications(javax.portlet.EventRequest req, javax.portlet.EventResponse res) syndicateAnnouncementsAsNotifications.

Methods inherited from class java.lang.Object

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

Field Detail

ACTION_DISPLAY_FULL_ANNOUNCEMENT

public static final String ACTION_DISPLAY_FULL_ANNOUNCEMENT

Constant ACTION_DISPLAY_FULL_ANNOUNCEMENT="displayFullAnnouncement"

See Also:

Constant Field Values

PREFERENCE_DISPLAY_STARTDATE

public static final String PREFERENCE_DISPLAY_STARTDATE

Constant PREFERENCE_DISPLAY_STARTDATE="AnnouncementsViewController.displayPubl"{trunked}

See Also:

Constant Field Values

PREFERENCE_DISABLE_EDIT

public static final String PREFERENCE_DISABLE_EDIT

Constant PREFERENCE_DISABLE_EDIT="AnnouncementsViewController.PREFERENCE_"{trunked}

See Also:

Constant Field Values

PREFERENCE_PAGE_SIZE

public static final String PREFERENCE_PAGE_SIZE

Constant PREFERENCE_PAGE_SIZE="AnnouncementsViewController.PAGE_SIZE"

See Also:

Constant Field Values

PREFERENCE_SORT_STRATEGY

public static final String PREFERENCE_SORT_STRATEGY

Constant PREFERENCE_SORT_STRATEGY="AnnouncementsViewController.Announcemen"{trunked}

See Also:

Constant Field Values

PREFERENCE_USE_SCROLLING_DISPLAY

public static final String PREFERENCE_USE_SCROLLING_DISPLAY

Constant PREFERENCE_USE_SCROLLING_DISPLAY="AnnouncementsViewController.useScrollin"{trunked}

See Also:

Constant Field Values

PREFERENCE_SCROLLING_DISPLAY_HEIGHT_PIXELS

public static final String PREFERENCE_SCROLLING_DISPLAY_HEIGHT_PIXELS

Constant PREFERENCE_SCROLLING_DISPLAY_HEIGHT_PIXELS="AnnouncementsViewController.scrollingDi"{trunked}

See Also:

Constant Field Values

PREFERENCE_HIDE_ABSTRACT

public static final String PREFERENCE_HIDE_ABSTRACT

Constant PREFERENCE_HIDE_ABSTRACT="AnnouncementsViewController.hideAbstrac"{trunked}

See Also:

Constant Field Values

PREFERENCE_SYNDICATE_TOPICS_AS_NOTIFICATIONS

public static final String PREFERENCE_SYNDICATE_TOPICS_AS_NOTIFICATIONS

Constant PREFERENCE_SYNDICATE_TOPICS_AS_NOTIFICATIONS="AnnouncementsViewController.syndicateTo"{trunked}

See Also:

Constant Field Values

PREFERENCE_SYNDICATE_TOPICS_ANNOUNCEMENTS_DISPLAY_FNAME

public static final String PREFERENCE_SYNDICATE_TOPICS_ANNOUNCEMENTS_DISPLAY_FNAME

Constant PREFERENCE_SYNDICATE_TOPICS_ANNOUNCEMENTS_DISPLAY_FNAME="AnnouncementsViewController.syndicateTo"{trunked}

See Also:

Constant Field Values

DEFAULT_SORT_STRATEGY

public static final String DEFAULT_SORT_STRATEGY

Constant DEFAULT_SORT_STRATEGY="START_DISPLAY_DATE_ASCENDING"

See Also:

Constant Field Values

NOTIFICATION_NAMESPACE

public static final String NOTIFICATION_NAMESPACE

Constant NOTIFICATION_NAMESPACE="https://source.jasig.org/schemas/portle"{trunked}

See Also:

Constant Field Values

NOTIFICATION_QUERY_LOCAL_NAME

public static final String NOTIFICATION_QUERY_LOCAL_NAME

Constant NOTIFICATION_QUERY_LOCAL_NAME="NotificationQuery"

See Also:

Constant Field Values

NOTIFICATION_QUERY_QNAME

public static final QName NOTIFICATION_QUERY_QNAME

Constant NOTIFICATION_QUERY_QNAME

NOTIFICATION_QUERY_QNAME_STRING

public static final String NOTIFICATION_QUERY_QNAME_STRING

Constant NOTIFICATION_QUERY_QNAME_STRING="{ + NOTIFICATION_NAMESPACE + } + NOTIFI"{trunked}

See Also:

Constant Field Values

NOTIFICATION_RESULT_LOCAL_NAME

public static final String NOTIFICATION_RESULT_LOCAL_NAME

Constant NOTIFICATION_RESULT_LOCAL_NAME="NotificationResult"

See Also:

Constant Field Values

NOTIFICATION_RESULT_QNAME

public static final QName NOTIFICATION_RESULT_QNAME

Constant NOTIFICATION_RESULT_QNAME

NOTIFICATION_RESULT_QNAME_STRING

public static final String NOTIFICATION_RESULT_QNAME_STRING

Constant NOTIFICATION_RESULT_QNAME_STRING="{ + NOTIFICATION_NAMESPACE + } + NOTIFI"{trunked}

See Also:

Constant Field Values

USER_TOPICS_CACHE

public static final String USER_TOPICS_CACHE

Constant USER_TOPICS_CACHE="userTopicLists"

See Also:

Constant Field Values

TOPICS_CACHE

public static final String TOPICS_CACHE

Constant TOPICS_CACHE="topicLists"

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 - a Model object.

request - a RenderRequest object.

from - a Integer object.

to - a Integer object.

Returns:

a String object.

Throws:

javax.portlet.PortletException - if any.

emergenciesResource

@ResourceMapping(value="emergencies")
public void emergenciesResource(javax.portlet.ResourceRequest request,
                                                                      javax.portlet.ResourceResponse response)
                                                               throws IOException,
                                                                      javax.portlet.PortletException

emergenciesResource.

Parameters:

request - a ResourceRequest object.

response - a ResourceResponse object.

Throws:

IOException - if any.

javax.portlet.PortletException - if any.

announcementsResource

@ResourceMapping(value="announcements")
public void announcementsResource(javax.portlet.ResourceRequest request,
                                                                          javax.portlet.ResourceResponse response)
                                                                   throws IOException,
                                                                          javax.portlet.PortletException

announcementsResource.

Parameters:

request - a ResourceRequest object.

response - a ResourceResponse object.

Throws:

IOException - if any.

javax.portlet.PortletException - if any.

displayFullAnnouncement

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

displayFullAnnouncement.

Parameters:

model - a Model object.

request - a RenderRequest object.

announcementId - a String object.

Returns:

a String object.

Throws:

Exception - if any.

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

syndicateAnnouncementsAsNotifications.

Parameters:

req - a EventRequest object.

res - a EventResponse object.

Throws:

javax.portlet.PortletException - if any.

getDisplayPublishDate

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

getDisplayPublishDate.

Parameters:

req - a PortletRequest object.

Returns:

a boolean.

setTss

public void setTss(ITopicSubscriptionService tss)

Setter for the field tss.

Parameters:

tss - a ITopicSubscriptionService object.

setCm

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

Setter for the field cm.

Parameters:

cm - a EhCacheCacheManager object.

displayFullAnnouncementHistory

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

displayFullAnnouncementHistory.

Parameters:

model - a Model object.

request - a RenderRequest object.

announcementId - a String object.

Returns:

a String object.

Throws:

Exception - if any.

displayHistory

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

displayHistory.

Parameters:

model - a Model object.

request - a RenderRequest object.

Returns:

a String object.

Throws:

Exception - if any.

getPageSize

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

getPageSize.

Parameters:

req - a PortletRequest object.

Returns:

a int.

isGuest

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

isGuest.

Parameters:

req - a PortletRequest object.

Returns:

a boolean.

getUseScrollingDisplay

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

getUseScrollingDisplay.

Parameters:

req - a PortletRequest object.

Returns:

a boolean.

getScrollingDisplayHeightPixels

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

getScrollingDisplayHeightPixels.

Parameters:

req - a PortletRequest object.

Returns:

a int.