A C D E F G I J N O P R S T V

A

ActionDTO - Class in org.jasig.portlet.notice.rest

ActionDTO() - Constructor for class org.jasig.portlet.notice.rest.ActionDTO

addEntries(List<NotificationEntry>) - Method in class org.jasig.portlet.notice.NotificationCategory

AddresseeDTO - Class in org.jasig.portlet.notice.rest

AddresseeDTO() - Constructor for class org.jasig.portlet.notice.rest.AddresseeDTO

AttributeDTO - Class in org.jasig.portlet.notice.rest

AttributeDTO() - Constructor for class org.jasig.portlet.notice.rest.AttributeDTO

C

clone() - Method in class org.jasig.portlet.notice.NotificationAction

Implements deep-copy clone.

clone() - Method in class org.jasig.portlet.notice.NotificationAttribute

Implements deep-copy clone.

clone() - Method in class org.jasig.portlet.notice.NotificationCategory

Implements deep-copy clone.

clone() - Method in class org.jasig.portlet.notice.NotificationEntry

Implements deep-copy clone.

clone() - Method in class org.jasig.portlet.notice.NotificationError

Implements deep-copy clone.

clone() - Method in class org.jasig.portlet.notice.NotificationResponse

Implements deep-copy clone.

cloneIfNotCloned() - Method in class org.jasig.portlet.notice.NotificationResponse

Best guess as to the reason this method exists: beans that produce fresh NotificationResponse objects (without cloning them) may safely cache them.

combine(NotificationResponse) - Method in class org.jasig.portlet.notice.NotificationResponse

Combine the contents of this response with the provided response and return a new instance of NotificationResponse.

D

deserialize(JsonParser, DeserializationContext) - Method in class org.jasig.portlet.notice.JsonAttributesDeserializer

deserialize(JsonParser, DeserializationContext) - Method in class org.jasig.portlet.notice.JsonDateDeserializer

deserialize(JsonParser, DeserializationContext) - Method in class org.jasig.portlet.notice.JsonNotificationActionDeserializer

E

EMPTY_RESPONSE - Static variable in class org.jasig.portlet.notice.NotificationResponse

Useful for returning an empty set of notices.

EntryDTO - Class in org.jasig.portlet.notice.rest

EntryDTO() - Constructor for class org.jasig.portlet.notice.rest.EntryDTO

equals(Object) - Method in class org.jasig.portlet.notice.NotificationAttribute

equals(Object) - Method in class org.jasig.portlet.notice.NotificationError

EventDTO - Class in org.jasig.portlet.notice.rest

EventDTO() - Constructor for class org.jasig.portlet.notice.rest.EventDTO

F

filter(Predicate<NotificationEntry>) - Method in class org.jasig.portlet.notice.NotificationResponse

Return a new instance of NotificationResponse containing only NotificationEntry objects within this response that match the specified Predicate.

filterErrors(Set<Integer>) - Method in class org.jasig.portlet.notice.NotificationResponse

Return a new instance of NotificationResponse from which the specified errors have been removed.

findNotificationEntryById(String) - Method in class org.jasig.portlet.notice.NotificationResponse

Returns the NotificationEntry with the specified id, or null if not present.

G

getActions() - Method in class org.jasig.portlet.notice.rest.EntryDTO

getAddressees() - Method in class org.jasig.portlet.notice.rest.EntryDTO

getApiUrl() - Method in class org.jasig.portlet.notice.NotificationAction

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

getAttributes() - Method in class org.jasig.portlet.notice.NotificationEntry

Open-ended collection of notification metadata.

getAttributes() - Method in class org.jasig.portlet.notice.rest.EntryDTO

getAttributesMap() - Method in class org.jasig.portlet.notice.NotificationEntry

Convenience method for obtaining the attributes in a more usable collection.

getAvailableActions() - Method in class org.jasig.portlet.notice.NotificationEntry

Open-ended collection of behaviors the user (recipient) can invoke upon the notification.

getBody() - Method in class org.jasig.portlet.notice.NotificationEntry

Optional body text for this notification.

getBody() - Method in class org.jasig.portlet.notice.rest.EntryDTO

getCategories() - Method in class org.jasig.portlet.notice.NotificationResponse

getClazz() - Method in class org.jasig.portlet.notice.NotificationAction

getClazz() - Method in class org.jasig.portlet.notice.rest.ActionDTO

getDueDate() - Method in class org.jasig.portlet.notice.NotificationEntry

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

getDueDate() - Method in class org.jasig.portlet.notice.rest.EntryDTO

getEntries() - Method in class org.jasig.portlet.notice.NotificationCategory

getError() - Method in class org.jasig.portlet.notice.NotificationError

getErrors() - Method in class org.jasig.portlet.notice.NotificationResponse

getId() - Method in class org.jasig.portlet.notice.NotificationAction

getId() - Method in class org.jasig.portlet.notice.NotificationEntry

getId() - Method in class org.jasig.portlet.notice.rest.ActionDTO

getId() - Method in class org.jasig.portlet.notice.rest.AddresseeDTO

getId() - Method in class org.jasig.portlet.notice.rest.AttributeDTO

getId() - Method in class org.jasig.portlet.notice.rest.EntryDTO

getId() - Method in class org.jasig.portlet.notice.rest.EventDTO

getId() - Method in class org.jasig.portlet.notice.rest.RecipientDTO

getImage() - Method in class org.jasig.portlet.notice.NotificationEntry

Optional URL of an image file associated with this notification.

getImage() - Method in class org.jasig.portlet.notice.rest.EntryDTO

getKey() - Method in class org.jasig.portlet.notice.NotificationError

getLabel() - Method in class org.jasig.portlet.notice.NotificationAction

getLabel() - Method in class org.jasig.portlet.notice.rest.ActionDTO

getLinkText() - Method in class org.jasig.portlet.notice.NotificationEntry

Optional text of the anchor tag linking to url.

getLinkText() - Method in class org.jasig.portlet.notice.rest.EntryDTO

getName() - Method in class org.jasig.portlet.notice.NotificationAttribute

getName() - Method in class org.jasig.portlet.notice.rest.AddresseeDTO

getName() - Method in class org.jasig.portlet.notice.rest.AttributeDTO

getNotificationResponse() - Method in class org.jasig.portlet.notice.NotificationResult

getPriority() - Method in class org.jasig.portlet.notice.NotificationEntry

Optional numeric representation of the relative importance of the notification.

getPriority() - Method in class org.jasig.portlet.notice.rest.EntryDTO

getQueryWindowId() - Method in class org.jasig.portlet.notice.NotificationQuery

getQueryWindowId() - Method in class org.jasig.portlet.notice.NotificationResult

getRecipients() - Method in class org.jasig.portlet.notice.rest.AddresseeDTO

getResultWindowId() - Method in class org.jasig.portlet.notice.NotificationResult

getSource() - Method in class org.jasig.portlet.notice.NotificationEntry

Provides the human-readable name for the source of this notification.

getSource() - Method in class org.jasig.portlet.notice.NotificationError

getSource() - Method in class org.jasig.portlet.notice.rest.EntryDTO

getState() - Method in class org.jasig.portlet.notice.rest.EventDTO

getStates() - Method in class org.jasig.portlet.notice.NotificationEntry

Open-ended Map of states that currently apply to this notification.

getTarget() - Method in class org.jasig.portlet.notice.NotificationAction

getTimestamp() - Method in class org.jasig.portlet.notice.rest.EventDTO

getTitle() - Method in class org.jasig.portlet.notice.NotificationCategory

getTitle() - Method in class org.jasig.portlet.notice.NotificationEntry

Required one-liner version of this notification.

getTitle() - Method in class org.jasig.portlet.notice.rest.EntryDTO

getType() - Method in class org.jasig.portlet.notice.rest.AddresseeDTO

getUrl() - Method in class org.jasig.portlet.notice.NotificationEntry

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

getUrl() - Method in class org.jasig.portlet.notice.rest.EntryDTO

getUsername() - Method in class org.jasig.portlet.notice.rest.EventDTO

getUsername() - Method in class org.jasig.portlet.notice.rest.RecipientDTO

getValues() - Method in class org.jasig.portlet.notice.NotificationAttribute

getValues() - Method in class org.jasig.portlet.notice.rest.AttributeDTO

I

invoke(ActionRequest, ActionResponse) - Method in class org.jasig.portlet.notice.NotificationAction

Deprecated.

Prefer interactions that are not based on the Portlet API

invoke(HttpServletRequest, HttpServletResponse) - Method in class org.jasig.portlet.notice.NotificationAction

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

isActive(Date, Set<NotificationState>) - Method in enum org.jasig.portlet.notice.NotificationState

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.

J

JsonAttributesDeserializer - Class in org.jasig.portlet.notice

Parse the attributes list.

JsonAttributesDeserializer() - Constructor for class org.jasig.portlet.notice.JsonAttributesDeserializer

JsonAttributesSerializer - Class in org.jasig.portlet.notice

Simplifies the JSON output of the custom attributes to a format that is easy for javascript to work with.

JsonAttributesSerializer() - Constructor for class org.jasig.portlet.notice.JsonAttributesSerializer

JsonDateDeserializer - Class in org.jasig.portlet.notice

Apparently there is no standard format for dates in JSON.

JsonDateDeserializer() - Constructor for class org.jasig.portlet.notice.JsonDateDeserializer

JsonDateSerializer - Class in org.jasig.portlet.notice

Apparently there is no standard format for dates in JSON.

JsonDateSerializer() - Constructor for class org.jasig.portlet.notice.JsonDateSerializer

JsonNotificationActionDeserializer - Class in org.jasig.portlet.notice

JsonNotificationActionDeserializer() - Constructor for class org.jasig.portlet.notice.JsonNotificationActionDeserializer

N

NOTIFICATION_NAMESPACE - Static variable in class org.jasig.portlet.notice.NotificationConstants

NOTIFICATION_QUERY_LOCAL_NAME - Static variable in class org.jasig.portlet.notice.NotificationConstants

NOTIFICATION_QUERY_QNAME - Static variable in class org.jasig.portlet.notice.NotificationConstants

NOTIFICATION_QUERY_QNAME_STRING - Static variable in class org.jasig.portlet.notice.NotificationConstants

NOTIFICATION_RESULT_LOCAL_NAME - Static variable in class org.jasig.portlet.notice.NotificationConstants

NOTIFICATION_RESULT_QNAME - Static variable in class org.jasig.portlet.notice.NotificationConstants

NOTIFICATION_RESULT_QNAME_STRING - Static variable in class org.jasig.portlet.notice.NotificationConstants

NotificationAction - Class in org.jasig.portlet.notice

Represents a behavior that a user may invoke on a notification.

NotificationAction() - Constructor for class org.jasig.portlet.notice.NotificationAction

NotificationAttribute - Class in org.jasig.portlet.notice

Represents an extra, weakly-typed piece of meta data attached to a NotificationEntry.

NotificationAttribute() - Constructor for class org.jasig.portlet.notice.NotificationAttribute

NotificationAttribute(String, String) - Constructor for class org.jasig.portlet.notice.NotificationAttribute

Shortcut constructor.

NotificationAttribute(String, List<String>) - Constructor for class org.jasig.portlet.notice.NotificationAttribute

NotificationCategory - Class in org.jasig.portlet.notice

Container class that holds the entries for a given category.

NotificationCategory() - Constructor for class org.jasig.portlet.notice.NotificationCategory

Constructor.

NotificationCategory(String, List<NotificationEntry>) - Constructor for class org.jasig.portlet.notice.NotificationCategory

Constructor.

NotificationConstants - Class in org.jasig.portlet.notice

Constants related to notification-portlet-api

NotificationConstants() - Constructor for class org.jasig.portlet.notice.NotificationConstants

NotificationEntry - Class in org.jasig.portlet.notice

This class represents a single notification.

NotificationEntry() - Constructor for class org.jasig.portlet.notice.NotificationEntry

NotificationError - Class in org.jasig.portlet.notice

This class is used report errors when a INotificationService tries to retrieve notifications but is unable to due to some error.

NotificationError() - Constructor for class org.jasig.portlet.notice.NotificationError

NotificationError(String, String) - Constructor for class org.jasig.portlet.notice.NotificationError

NotificationQuery - Class in org.jasig.portlet.notice

NotificationQuery() - Constructor for class org.jasig.portlet.notice.NotificationQuery

NotificationResponse - Class in org.jasig.portlet.notice

This class contains all the categories and errors retrieved by an INotificationService.

NotificationResponse() - Constructor for class org.jasig.portlet.notice.NotificationResponse

NotificationResponse(NotificationResponse) - Constructor for class org.jasig.portlet.notice.NotificationResponse

NotificationResponse(List<NotificationCategory>, List<NotificationError>) - Constructor for class org.jasig.portlet.notice.NotificationResponse

NotificationResult - Class in org.jasig.portlet.notice

NotificationResult() - Constructor for class org.jasig.portlet.notice.NotificationResult

NotificationState - Enum in org.jasig.portlet.notice

Represents a state that a NotificationEntry is currently in, such as new, completed, or favorated.

O

org.jasig.portlet.notice - package org.jasig.portlet.notice

This package contains a simple data model for Notifications for the purpose of communicating them between components such as a remote data source, the server-side portlet code (controllers), and the browser-based UI.

org.jasig.portlet.notice.rest - package org.jasig.portlet.notice.rest

P

PRIORITY_UNSPECIFIED - Static variable in class org.jasig.portlet.notice.NotificationEntry

The priority field of a NotificationEntry will contain this value when the priority is unspecified by the source.

R

RecipientDTO - Class in org.jasig.portlet.notice.rest

RecipientDTO() - Constructor for class org.jasig.portlet.notice.rest.RecipientDTO

RecipientType - Enum in org.jasig.portlet.notice.rest

S

serialize(List<NotificationAttribute>, JsonGenerator, SerializerProvider) - Method in class org.jasig.portlet.notice.JsonAttributesSerializer

serialize(Date, JsonGenerator, SerializerProvider) - Method in class org.jasig.portlet.notice.JsonDateSerializer

setActions(Set<ActionDTO>) - Method in class org.jasig.portlet.notice.rest.EntryDTO

setAddressees(Set<AddresseeDTO>) - Method in class org.jasig.portlet.notice.rest.EntryDTO

setApiUrl(String) - Method in class org.jasig.portlet.notice.NotificationAction

Sets the URL for invoking this action through the NotificationRestV2Controller.

setAttributes(List<NotificationAttribute>) - Method in class org.jasig.portlet.notice.NotificationEntry

setAttributes(Set<AttributeDTO>) - Method in class org.jasig.portlet.notice.rest.EntryDTO

setAvailableActions(List<NotificationAction>) - Method in class org.jasig.portlet.notice.NotificationEntry

setBody(String) - Method in class org.jasig.portlet.notice.NotificationEntry

setBody(String) - Method in class org.jasig.portlet.notice.rest.EntryDTO

setCategories(List<NotificationCategory>) - Method in class org.jasig.portlet.notice.NotificationResponse

setClazz(String) - Method in class org.jasig.portlet.notice.rest.ActionDTO

setDueDate(Date) - Method in class org.jasig.portlet.notice.NotificationEntry

setDueDate(Timestamp) - Method in class org.jasig.portlet.notice.rest.EntryDTO

setEntries(List<NotificationEntry>) - Method in class org.jasig.portlet.notice.NotificationCategory

setError(String) - Method in class org.jasig.portlet.notice.NotificationError

setErrors(List<NotificationError>) - Method in class org.jasig.portlet.notice.NotificationResponse

setId(String) - Method in class org.jasig.portlet.notice.NotificationAction

Identifies the action, from among the available set of actions, when the user invokes it.

setId(String) - Method in class org.jasig.portlet.notice.NotificationEntry

Sets the unique identifier for this notification.

setId(long) - Method in class org.jasig.portlet.notice.rest.ActionDTO

setId(long) - Method in class org.jasig.portlet.notice.rest.AddresseeDTO

setId(long) - Method in class org.jasig.portlet.notice.rest.AttributeDTO

setId(long) - Method in class org.jasig.portlet.notice.rest.EntryDTO

setId(long) - Method in class org.jasig.portlet.notice.rest.EventDTO

setId(long) - Method in class org.jasig.portlet.notice.rest.RecipientDTO

setImage(String) - Method in class org.jasig.portlet.notice.NotificationEntry

setImage(String) - Method in class org.jasig.portlet.notice.rest.EntryDTO

setLabel(String) - Method in class org.jasig.portlet.notice.NotificationAction

setLabel(String) - Method in class org.jasig.portlet.notice.rest.ActionDTO

setLinkText(String) - Method in class org.jasig.portlet.notice.NotificationEntry

setLinkText(String) - Method in class org.jasig.portlet.notice.rest.EntryDTO

setName(String) - Method in class org.jasig.portlet.notice.NotificationAttribute

setName(String) - Method in class org.jasig.portlet.notice.rest.AddresseeDTO

setName(String) - Method in class org.jasig.portlet.notice.rest.AttributeDTO

setNotificationResponse(NotificationResponse) - Method in class org.jasig.portlet.notice.NotificationResult

setPriority(int) - Method in class org.jasig.portlet.notice.NotificationEntry

setPriority(int) - Method in class org.jasig.portlet.notice.rest.EntryDTO

setQueryWindowId(String) - Method in class org.jasig.portlet.notice.NotificationQuery

setQueryWindowId(String) - Method in class org.jasig.portlet.notice.NotificationResult

setRecipients(Set<RecipientDTO>) - Method in class org.jasig.portlet.notice.rest.AddresseeDTO

setResultWindowId(String) - Method in class org.jasig.portlet.notice.NotificationResult

setSource(String) - Method in class org.jasig.portlet.notice.NotificationEntry

setSource(String) - Method in class org.jasig.portlet.notice.NotificationError

setSource(String) - Method in class org.jasig.portlet.notice.rest.EntryDTO

setState(NotificationState) - Method in class org.jasig.portlet.notice.rest.EventDTO

setStates(Map<NotificationState, Date>) - Method in class org.jasig.portlet.notice.NotificationEntry

setTimestamp(Timestamp) - Method in class org.jasig.portlet.notice.rest.EventDTO

setTitle(String) - Method in class org.jasig.portlet.notice.NotificationCategory

setTitle(String) - Method in class org.jasig.portlet.notice.NotificationEntry

setTitle(String) - Method in class org.jasig.portlet.notice.rest.EntryDTO

setType(RecipientType) - Method in class org.jasig.portlet.notice.rest.AddresseeDTO

setUrl(String) - Method in class org.jasig.portlet.notice.NotificationEntry

setUrl(String) - Method in class org.jasig.portlet.notice.rest.EntryDTO

setUsername(String) - Method in class org.jasig.portlet.notice.rest.EventDTO

setUsername(String) - Method in class org.jasig.portlet.notice.rest.RecipientDTO

setValues(List<String>) - Method in class org.jasig.portlet.notice.NotificationAttribute

setValues(List<String>) - Method in class org.jasig.portlet.notice.rest.AttributeDTO

size() - Method in class org.jasig.portlet.notice.NotificationResponse

Provides the total number of notifications contained in the response.

T

toString() - Method in class org.jasig.portlet.notice.NotificationAttribute

toString() - Method in class org.jasig.portlet.notice.NotificationCategory

toString() - Method in class org.jasig.portlet.notice.NotificationEntry

toString() - Method in class org.jasig.portlet.notice.NotificationError

toString() - Method in class org.jasig.portlet.notice.NotificationResponse

toString() - Method in class org.jasig.portlet.notice.rest.EventDTO

V

valueOf(String) - Static method in enum org.jasig.portlet.notice.NotificationState

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.jasig.portlet.notice.rest.RecipientType

Returns the enum constant of this type with the specified name.

values() - Static method in enum org.jasig.portlet.notice.NotificationState

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

values() - Static method in enum org.jasig.portlet.notice.rest.RecipientType

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

A C D E F G I J N O P R S T V