org.jasig.portlet.notice

Class NotificationResponse

java.lang.Object

org.jasig.portlet.notice.NotificationResponse

All Implemented Interfaces:

Serializable, Cloneable

public class NotificationResponse
extends Object
implements Serializable, Cloneable

This class contains all the categories and errors retrieved by an INotificationService. It is also used to aggregate all the NotificationResponses from various services into a single NotificationResponse. The data from the overall NotificationResponse instance is returned to the portlet to be rendered.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
NotificationResponse()
NotificationResponse(List<NotificationCategory> categories, List<NotificationError> errors)
NotificationResponse(NotificationResponse response)

Method Summary

Methods

Modifier and Type	Method and Description
Object	clone() Implements deep-copy clone.
NotificationResponse	combine(NotificationResponse response) Combine the contents of this response with the provided response and return a new instance of NotificationResponse.
NotificationResponse	filterErrors(Set<Integer> hiddenErrorKeys) Return a new instance of NotificationResponse from which the specified errors have been removed.
NotificationEntry	findNotificationEntryById(String notificationId) Returns the NotificationEntry with the specified id, or null if not present.
List<NotificationCategory>	getCategories()
List<NotificationError>	getErrors()
void	setCategories(List<NotificationCategory> categories)
void	setErrors(List<NotificationError> errors)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

NotificationResponse

public NotificationResponse()

NotificationResponse

public NotificationResponse(NotificationResponse response)

NotificationResponse

public NotificationResponse(List<NotificationCategory> categories,
                    List<NotificationError> errors)

Method Detail

getCategories

public List<NotificationCategory> getCategories()

setCategories

public void setCategories(List<NotificationCategory> categories)

getErrors

public List<NotificationError> getErrors()

setErrors

public void setErrors(List<NotificationError> errors)

findNotificationEntryById

public NotificationEntry findNotificationEntryById(String notificationId)

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

combine

public NotificationResponse combine(NotificationResponse response)

Combine the contents of this response with the provided response and return a new instance of NotificationResponse. The original instances are unchanged.

Parameters:

A - new NotificationResponse that contains data from both originals

filterErrors

public NotificationResponse filterErrors(Set<Integer> hiddenErrorKeys)

Return a new instance of NotificationResponse from which the specified errors have been removed. The original instances are unchanged.

Parameters:

A - new NotificationResponse that does not contain the specified errors

toString

public String toString()

Overrides:

toString in class Object

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.