org.jasig.portlet.notice

Class NotificationAction

java.lang.Object

org.jasig.portlet.notice.NotificationAction

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public abstract class NotificationAction
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable

Represents a behavior that a user may invoke on a notification. The possibilities are open-ended, but some examples include Hide, Mark as done, and Favorite. Concrete service impls must provide the business logic to perform the action, as well as implement the invoke method.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
NotificationAction()

Method Summary

Modifier and Type	Method and Description
java.lang.Object	clone() Implements deep-copy clone.
java.lang.String	getApiUrl() Complete URL (ncluding CSRF token, if appropriate) that can be used to invoke this action through the NotificationRestV2Controller.
java.lang.String	getClazz()
java.lang.String	getId()
java.lang.String	getLabel()
NotificationEntry	getTarget()
abstract void	invoke(javax.portlet.ActionRequest req, javax.portlet.ActionResponse res) Deprecated. Prefer interactions that are not based on the Portlet API
abstract void	invoke(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Perform this action on the notification to which it is attached.
void	setApiUrl(java.lang.String apiUrl) Sets the URL for invoking this action through the NotificationRestV2Controller.
void	setId(java.lang.String id) Identifies the action, from among the available set of actions, when the user invokes it.
void	setLabel(java.lang.String label)

Methods inherited from class java.lang.Object

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

Constructor Detail

NotificationAction

public NotificationAction()

Method Detail

getClazz

public final java.lang.String getClazz()

getId

public final java.lang.String getId()

setId

public final void setId(java.lang.String id)

Identifies the action, from among the available set of actions, when the user invokes it. Must be unique within the notification. The default is the simpleName of the implementing class, so subclasses that can appear more than once within a notification should override it.

getLabel

public final java.lang.String getLabel()

setLabel

public final void setLabel(java.lang.String label)

getTarget

public final NotificationEntry getTarget()

getApiUrl

public java.lang.String getApiUrl()

Complete URL (ncluding CSRF token, if appropriate) that can be used to invoke this action through the NotificationRestV2Controller.

setApiUrl

public void setApiUrl(java.lang.String apiUrl)

Sets the URL for invoking this action through the NotificationRestV2Controller. This field should not be provided by the data source (i.e. Notification Service). It must be set by the API layer.

invoke

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

Deprecated. Prefer interactions that are not based on the Portlet API

Perform this action on the notification to which it is attached.

Throws:

java.io.IOException

invoke

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

Perform this action on the notification to which it is attached.

Throws:

java.io.IOException

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Implements deep-copy clone.

Overrides:

clone in class java.lang.Object

Throws:

java.lang.CloneNotSupportedException - Not really, but it's on the method signature we're overriding.