org.jasig.portlet.notice.action.hide

Class HideNotificationServiceDecorator

java.lang.Object

org.jasig.portlet.notice.action.hide.HideNotificationServiceDecorator

All Implemented Interfaces:

INotificationService

public class HideNotificationServiceDecorator
extends Object
implements INotificationService

This class can be used to add a "hide" or "snooze" feature to notifications that have an id attribute. By default, notices will be hidden for 365 days (effectively permanent).

Author:

awills

Field Summary

Fields

Modifier and Type	Field and Description
static Integer	DEFAULT_HIDE_DURATION
static String	HIDE_DURATION_HOURS_PREFERENCE

Constructor Summary

Constructors

Constructor and Description
HideNotificationServiceDecorator()

Method Summary

Methods

Modifier and Type	Method and Description
void	collect(javax.portlet.EventRequest req, javax.portlet.EventResponse res) This method allows INotificationService implementations that receive portlet events to collect notifications from other portlets in the portal.
NotificationResponse	fetch(javax.portlet.PortletRequest req) Provide the current collection of Notifications information for the user represented by the PortletRequest.
String	getName() Returns the name of the service, which should be unique in the portlet app.
void	invoke(javax.portlet.ActionRequest req, javax.portlet.ActionResponse res, boolean refresh) This method 'primes the pump' for INotificationService implementations.
boolean	isValid(javax.portlet.PortletRequest req, NotificationResponse previousResponse) Indicates whether a previous (presumably cached) NotificationResponse is still valid.
void	setEnclosedNotificationService(INotificationService enclosedNotificationService)

Methods inherited from class java.lang.Object

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

Field Detail

HIDE_DURATION_HOURS_PREFERENCE

public static final String HIDE_DURATION_HOURS_PREFERENCE

See Also:

Constant Field Values

DEFAULT_HIDE_DURATION

public static final Integer DEFAULT_HIDE_DURATION

Constructor Detail

HideNotificationServiceDecorator

public HideNotificationServiceDecorator()

Method Detail

setEnclosedNotificationService

public void setEnclosedNotificationService(INotificationService enclosedNotificationService)

getName

public String getName()

Description copied from interface: INotificationService

Returns the name of the service, which should be unique in the portlet app.

Specified by:

getName in interface INotificationService

Returns:

A unique name for this service

invoke

public void invoke(javax.portlet.ActionRequest req,
          javax.portlet.ActionResponse res,
          boolean refresh)

Description copied from interface: INotificationService

This method 'primes the pump' for INotificationService implementations. Not all concrete services will need this method, and those that don't can safely make it a no-op. But those that do need it can rely on receiving a call to invoke() before receiving a call to fetch().

Specified by:

invoke in interface INotificationService

Parameters:

req - The current ActionRequest

res - The current ActionResponse

refresh - If true, the service should expire any cached data

collect

public void collect(javax.portlet.EventRequest req,
           javax.portlet.EventResponse res)

Description copied from interface: INotificationService

This method allows INotificationService implementations that receive portlet events to collect notifications from other portlets in the portal. Not all concrete services will need this method, and those that don't can safely make it a no-op.

Specified by:

collect in interface INotificationService

Parameters:

req - The current EventRequest

res - The current EventResponse

fetch

public NotificationResponse fetch(javax.portlet.PortletRequest req)

Description copied from interface: INotificationService

Provide the current collection of Notifications information for the user represented by the PortletRequest.

Specified by:

fetch in interface INotificationService

Parameters:

req - The PortletRequest

Returns:

A collection of notifications and/or errors

isValid

public boolean isValid(javax.portlet.PortletRequest req,
              NotificationResponse previousResponse)

Description copied from interface: INotificationService

Indicates whether a previous (presumably cached) NotificationResponse is still valid. A few service implementations will be able to make this determination without contacting a remote service or doing anything computationally expensive. Those that can't should just return true; they will have the chance to update their responses when the cached version expires or when the user clicks refresh.

Specified by:

isValid in interface INotificationService

Parameters:

req - The current request

previousResponse - A response provided by this service at an earlier point

Returns:

true if the earlier response is still acceptable for the present