org.jasig.portlet.notice.action.read

Class ReadAction

java.lang.Object

org.jasig.portlet.notice.NotificationAction

org.jasig.portlet.notice.action.read.ReadAction

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

Direct Known Subclasses:

MarkAsReadAndRedirectAction

public class ReadAction
extends org.jasig.portlet.notice.NotificationAction

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.slf4j.Logger	logger
static ReadAction	READ This INSTANCE is only for convenience -- READ and UNREAD not singletons.

Constructor Summary

Constructors

Constructor and Description
ReadAction() Must remain public, no-arg for de-serialization.
ReadAction(java.lang.String label)

Method Summary

Modifier and Type	Method and Description
static ReadAction	createReadInstance()
static ReadAction	createUnReadInstance()
boolean	equals(java.lang.Object obj)
int	hashCode()
void	invoke(javax.portlet.ActionRequest req, javax.portlet.ActionResponse res) Invoking a ReadAction toggles it.
void	invoke(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
protected boolean	isRead(org.jasig.portlet.notice.NotificationEntry entry, java.lang.String username)
void	removeReadNotices(javax.portlet.PortletRequest req, java.util.Set<java.lang.String> idsToRemove)

Methods inherited from class org.jasig.portlet.notice.NotificationAction

clone, getApiUrl, getClazz, getId, getLabel, getTarget, setApiUrl, setId, setLabel

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

logger

protected static org.slf4j.Logger logger

READ

public static final ReadAction READ

This INSTANCE is only for convenience -- READ and UNREAD not singletons. There may be situations where de-serialization will create additional instances, and that's okay.

Constructor Detail

ReadAction

public ReadAction()

Must remain public, no-arg for de-serialization.

ReadAction

public ReadAction(java.lang.String label)

Method Detail

createReadInstance

public static final ReadAction createReadInstance()

createUnReadInstance

public static final ReadAction createUnReadInstance()

invoke

public void invoke(javax.portlet.ActionRequest req,
                   javax.portlet.ActionResponse res)
            throws java.io.IOException

Invoking a ReadAction toggles it.

Specified by:

invoke in class org.jasig.portlet.notice.NotificationAction

Throws:

java.io.IOException

invoke

public void invoke(javax.servlet.http.HttpServletRequest request,
                   javax.servlet.http.HttpServletResponse response)
            throws java.io.IOException

Specified by:

invoke in class org.jasig.portlet.notice.NotificationAction

Throws:

java.io.IOException

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

removeReadNotices

public void removeReadNotices(javax.portlet.PortletRequest req,
                              java.util.Set<java.lang.String> idsToRemove)

isRead

protected boolean isRead(org.jasig.portlet.notice.NotificationEntry entry,
                         java.lang.String username)