org.jasig.portlet.notice

Class NotificationEntry

java.lang.Object

org.jasig.portlet.notice.NotificationEntry

All Implemented Interfaces:

Serializable, Cloneable

public class NotificationEntry
extends Object
implements Serializable, Cloneable

This class represents a single notification. It defines a handful of strongly-typed members, plus a few open-ended collections. These collections are for attributes, actions, and states. Strongly-typed items are chosen primarily because they require framework-level special handling. The open-ended collections make the platform extensible. Please add additional members only as a last resort.

The NotificationCategory class contains all the entries for the same category title.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
NotificationEntry()

Method Summary

Methods

Modifier and Type	Method and Description
Object	clone() Implements deep-copy clone.
List<NotificationAttribute>	getAttributes() Open-ended collection of notification metadata.
List<NotificationAction>	getAvailableActions() Open-ended collection of behaviors the user (recipient) can invoke upon the notification.
String	getBody() Optional body text for this notification.
Date	getDueDate() Optional date/time indicating by when the action described in this notification must be completed.
String	getId()
String	getImage() Optional URL of an image file associated with this notification.
String	getLinkText() Optional text of the anchor tag linking to url.
int	getPriority() Optional numeric representation of the relative importance of the notification.
String	getSource() Provides the human-readable name for the source of this notification.
Map<NotificationState,Date>	getStates() Open-ended Map of states that currently apply to this notification.
String	getTitle() Required one-liner version of this notification.
String	getUrl() Optional web address where the user can deal with or learn more about the details of this notification.
void	setAttributes(List<NotificationAttribute> attributes)
void	setAvailableActions(List<NotificationAction> availableActions)
void	setBody(String body)
void	setDueDate(Date dueDate)
void	setId(String id) Sets the unique identifier for this notification.
void	setImage(String imageUrl)
void	setLinkText(String linkText)
void	setPriority(int priority)
void	setSource(String source)
void	setStates(Map<NotificationState,Date> states)
void	setTitle(String title)
void	setUrl(String url)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

NotificationEntry

public NotificationEntry()

Method Detail

getSource

public String getSource()

Provides the human-readable name for the source of this notification. E.g. 'Office of the Registrar'

setSource

public void setSource(String source)

getId

public String getId()

setId

public void setId(String id)

Sets the unique identifier for this notification. Ids are not required except for notifications that support actions. The value of the id field can be any javascript-safe String, but must be unique within a user's collection of notifications. UUID.randomUUID() could be a good way to generate them.

getTitle

public String getTitle()

Required one-liner version of this notification. E.g. 'You have 3 overdue library books.'

setTitle

public void setTitle(String title)

getUrl

public String getUrl()

Optional web address where the user can deal with or learn more about the details of this notification.

setUrl

public void setUrl(String url)

getLinkText

public String getLinkText()

Optional text of the anchor tag linking to url.

setLinkText

public void setLinkText(String linkText)

getPriority

public int getPriority()

Optional numeric representation of the relative importance of the notification. Vales range from 1 (most important) to 5 (least important).

setPriority

public void setPriority(int priority)

getDueDate

public Date getDueDate()

Optional date/time indicating by when the action described in this notification must be completed.

setDueDate

public void setDueDate(Date dueDate)

getImage

public String getImage()

Optional URL of an image file associated with this notification. Might be the logo of the source system or something more specific.

setImage

public void setImage(String imageUrl)

getBody

public String getBody()

Optional body text for this notification. Supports HTML tags.

setBody

public void setBody(String body)

getAttributes

public List<NotificationAttribute> getAttributes()

Open-ended collection of notification metadata. The presumption is that attributes will be visible to users.

setAttributes

public void setAttributes(List<NotificationAttribute> attributes)

getAvailableActions

public List<NotificationAction> getAvailableActions()

Open-ended collection of behaviors the user (recipient) can invoke upon the notification. E.g. 'hide' or 'mark as done'. Different Notification UIs may support different behaviors (viz. not all behaviors will be supported by all view JSPs).

setAvailableActions

public void setAvailableActions(List<NotificationAction> availableActions)

getStates

public Map<NotificationState,Date> getStates()

Open-ended Map of states that currently apply to this notification. Keys are the states themselves, while values provide a way to indicate the moment when the state was applied. Data sources may leave values null.

Since:

2.2

setStates

public void setStates(Map<NotificationState,Date> states)

Since:

2.2

clone

public Object clone()
             throws CloneNotSupportedException

Implements deep-copy clone.

Overrides:

clone in class Object

Throws:

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

toString

public String toString()

Overrides:

toString in class Object