org.jasig.portlet.notice.action.favorite

Class FavoriteAction

java.lang.Object

org.jasig.portlet.notice.NotificationAction

org.jasig.portlet.notice.action.favorite.FavoriteAction

All Implemented Interfaces:

Serializable, Cloneable

public final class FavoriteAction
extends NotificationAction

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static FavoriteAction	FAVORITE This INSTANCE is only for convenience -- FAVORITE and UNFAVORITE not singletons.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static FavoriteAction	createFavoriteInstance()
static FavoriteAction	createUnfavoriteInstance()
boolean	equals(Object obj)
int	hashCode()
void	invoke(javax.portlet.ActionRequest req, javax.portlet.ActionResponse res) Invoking a FavoriteAction toggles it.
void	removeFavoriteNotices(javax.portlet.PortletRequest req, Set<String> idsToRemove)

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

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

Methods inherited from class java.lang.Object

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

Field Detail

FAVORITE

public static final FavoriteAction FAVORITE

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

Constructor Detail

FavoriteAction

public FavoriteAction()

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

FavoriteAction

public FavoriteAction(String label)

Method Detail

createFavoriteInstance

public static final FavoriteAction createFavoriteInstance()

createUnfavoriteInstance

public static final FavoriteAction createUnfavoriteInstance()

invoke

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

Invoking a FavoriteAction toggles it.

Specified by:

invoke in class NotificationAction

Throws:

IOException

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

removeFavoriteNotices

public void removeFavoriteNotices(javax.portlet.PortletRequest req,
                                  Set<String> idsToRemove)