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 within the portlet. It defines a handful of strongly-typed members, plus an open-ended collection of attributes. Strongly-typed items are chosen primarily because they support special handling in the UI (i.e. clickable URL).

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()
List<NotificationAction>	getAvailableActions()
String	getBody()
Date	getDueDate()
String	getId()
String	getImage()
String	getLinkText()
int	getPriority()
String	getSource()
String	getTitle()
String	getUrl()
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	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()

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()

setTitle

public void setTitle(String title)

getUrl

public String getUrl()

setUrl

public void setUrl(String url)

getLinkText

public String getLinkText()

setLinkText

public void setLinkText(String linkText)

getPriority

public int getPriority()

setPriority

public void setPriority(int priority)

getDueDate

public Date getDueDate()

setDueDate

public void setDueDate(Date dueDate)

getImage

public String getImage()

setImage

public void setImage(String imageUrl)

getBody

public String getBody()

setBody

public void setBody(String body)

getAttributes

public List<NotificationAttribute> getAttributes()

setAttributes

public void setAttributes(List<NotificationAttribute> attributes)

getAvailableActions

public List<NotificationAction> getAvailableActions()

setAvailableActions

public void setAvailableActions(List<NotificationAction> availableActions)

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