NotificationEntry (notification-portlet-api 4.1.2 API)

java.lang.Object
- org.jasig.portlet.notice.NotificationEntry

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable
```
public class NotificationEntry
extends java.lang.Object
implements java.io.Serializable, java.lang.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

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`PRIORITY_UNSPECIFIED` The `priority` field of a `NotificationEntry` will contain this value when the priority is unspecified by the source.

Constructor Summary

Constructors
Constructor and Description

NotificationEntry()

Constructors
Constructor and Description
`NotificationEntry()`

Method Summary

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

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - PRIORITY_UNSPECIFIED
```
public static final int PRIORITY_UNSPECIFIED
```
    The priority field of a NotificationEntry will contain this value when the priority is unspecified by the source.
    
    Since:
    
    3.1
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - NotificationEntry
```
public NotificationEntry()
```
- Method Detail
  - getSource
```
public java.lang.String getSource()
```
    Provides the human-readable name for the source of this notification. E.g. 'Office of the Registrar'
  - setSource
```
public void setSource(java.lang.String source)
```
  - getId
```
public java.lang.String getId()
```
  - setId
```
public void setId(java.lang.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 java.lang.String getTitle()
```
    Required one-liner version of this notification. E.g. 'You have 3 overdue library books.'
  - setTitle
```
public void setTitle(java.lang.String title)
```
  - getUrl
```
public java.lang.String getUrl()
```
    Optional web address where the user can deal with or learn more about the details of this notification.
  - setUrl
```
public void setUrl(java.lang.String url)
```
  - getLinkText
```
public java.lang.String getLinkText()
```
    Optional text of the anchor tag linking to url.
  - setLinkText
```
public void setLinkText(java.lang.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 java.util.Date getDueDate()
```
    Optional date/time indicating by when the action described in this notification must be completed.
  - setDueDate
```
public void setDueDate(java.util.Date dueDate)
```
  - getImage
```
public java.lang.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(java.lang.String imageUrl)
```
  - getBody
```
public java.lang.String getBody()
```
    Optional body text for this notification. Supports HTML tags.
  - setBody
```
public void setBody(java.lang.String body)
```
  - getAttributes
```
public java.util.List<NotificationAttribute> getAttributes()
```
    Open-ended collection of notification metadata. The presumption is that attributes will be visible to users.
  - setAttributes
```
public void setAttributes(java.util.List<NotificationAttribute> attributes)
```
  - getAttributesMap
```
public java.util.Map<java.lang.String,java.util.List<java.lang.String>> getAttributesMap()
```
    Convenience method for obtaining the attributes in a more usable collection.
  - getAvailableActions
```
public java.util.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(java.util.List<NotificationAction> availableActions)
```
  - getStates
```
public java.util.Map<NotificationState,java.util.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(java.util.Map<NotificationState,java.util.Date> states)
```
    Since:
    
    2.2
  - 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.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class NotificationEntry

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PRIORITY_UNSPECIFIED

Constructor Detail

NotificationEntry

Method Detail

getSource

setSource

getId

setId

getTitle

setTitle

getUrl

setUrl

getLinkText

setLinkText

getPriority

setPriority

getDueDate

setDueDate

getImage

setImage

getBody

setBody

getAttributes

setAttributes

getAttributesMap

getAvailableActions

setAvailableActions

getStates

setStates

clone

toString