org.jasig.portlet.notice

Enum NotificationState

java.lang.Object

java.lang.Enum<NotificationState>

org.jasig.portlet.notice.NotificationState

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<NotificationState>

public enum NotificationState
extends java.lang.Enum<NotificationState>

Represents a state that a NotificationEntry is currently in, such as new, completed, or favorated. This list is intended to be comprehensive, but new states may be added in the future as needed. Notification data sources are afforded reasonable latitude as to when and how a notification enters into a state. All states are optional. View implementations vary as to how they represent a state to a user, or whether they represent it.

Since:

2.2

Enum Constant Summary

Enum Constants

Enum Constant and Description
ACKNOWLEDGED Indicates the user has signaled receipt of the NotificationEntry, typically because the sender of the notification requested it.
ARCHIVED Indicates the NotificationEntry is no longer in the user's active notifications.
COMPLETED Indicates the NotificationEntry is about a task that is completed.
EMAILED Indicates the recipient was sent an email about the NotificationEntry.
FAVORITED Indicates the user "starred" or "favorited" the NotificationEntry.
IN_PROGRESS Indicates the NotificationEntry is about a task that is partially completed..
ISSUED Registered when the NotificationEntry is assigned to an individual.
PUSHED Indicates the NotificationEntry has been pushed to a mobile device.
READ Indicates that (at minimum) the title of the NotificationEntry was displayed to to the recipient.
SNOOZED Indicates the user dismissed the NotificationEntry temporarily.
TEXTED Indicates the recipient was sent an SMS message to alert him or her about the NotificationEntry.
UPDATED Indicates one or more fields of the NotificationEntry were modified after it was created.

Method Summary

Modifier and Type	Method and Description
boolean	isActive(java.util.Date timestamp, java.util.Set<NotificationState> subsequentHistory) Indicates whether this NotificationState is still considered "active" given when it occurred (the specified timestamp) and the subsequent history of the NotificationEntry for this user.
static NotificationState	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static NotificationState[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ISSUED

public static final NotificationState ISSUED

Registered when the NotificationEntry is assigned to an individual. Represents the creation date of a notification vis-a-vis a recipient.

UPDATED

public static final NotificationState UPDATED

Indicates one or more fields of the NotificationEntry were modified after it was created.

PUSHED

public static final NotificationState PUSHED

Indicates the NotificationEntry has been pushed to a mobile device.

TEXTED

public static final NotificationState TEXTED

Indicates the recipient was sent an SMS message to alert him or her about the NotificationEntry.

EMAILED

public static final NotificationState EMAILED

Indicates the recipient was sent an email about the NotificationEntry.

READ

public static final NotificationState READ

Indicates that (at minimum) the title of the NotificationEntry was displayed to to the recipient. Notifications with the READ state may be considered no longer new.

ACKNOWLEDGED

public static final NotificationState ACKNOWLEDGED

Indicates the user has signaled receipt of the NotificationEntry, typically because the sender of the notification requested it.

FAVORITED

public static final NotificationState FAVORITED

Indicates the user "starred" or "favorited" the NotificationEntry. This state must be removed if the user later undoes the action.

SNOOZED

public static final NotificationState SNOOZED

Indicates the user dismissed the NotificationEntry temporarily. This state must be removed after a (probably configurable) period has elapsed.

IN_PROGRESS

public static final NotificationState IN_PROGRESS

Indicates the NotificationEntry is about a task that is partially completed..

COMPLETED

public static final NotificationState COMPLETED

Indicates the NotificationEntry is about a task that is completed.

ARCHIVED

public static final NotificationState ARCHIVED

Indicates the NotificationEntry is no longer in the user's active notifications. Notifications may be archived by user action or by system rules.

Method Detail

values

public static NotificationState[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (NotificationState c : NotificationState.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static NotificationState valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

isActive

public boolean isActive(java.util.Date timestamp,
                        java.util.Set<NotificationState> subsequentHistory)

Indicates whether this NotificationState is still considered "active" given when it occurred (the specified timestamp) and the subsequent history of the NotificationEntry for this user. Most states can use the default implementation of this method, which simply returns true. States that may be effectively "canceled" by other states -- or by the passage of time -- should override this method.

Parameters:

timestamp - The moment when this state was applied

subsequentHistory - States that were applied to this NotificationEntry for this user after this one.

Returns:

TRUE if this state is still considered active for this NotificationEntry for this user