org.xwiki.notifications.sources

Class NotificationParameters

java.lang.Object

org.xwiki.notifications.sources.NotificationParameters

public class NotificationParameters
extends Object

Parameters to fill to retrieve notifications using ParametrizedNotificationManager.

Since:

10.4

Version:

$Id: 8732274f98309126fed299d50a1341ba9c0f10e3 $

Field Summary

Fields

Modifier and Type	Field and Description
Collection<String>	blackList List of event IDs not to return.
Date	endDate Don't get notifications that have been triggered after the following date.
boolean	endDateIncluded True if the end date should be included.
int	expectedCount The maximum number of notifications to return.
Collection<NotificationFilterPreference>	filterPreferences List of filter preferences to apply.
Collection<NotificationFilter>	filters List of filters to apply.
org.xwiki.notifications.NotificationFormat	format The format of the notifications to get.
Date	fromDate Don't get notification that have been triggered before the following date.
Boolean	onlyUnread Display only unread notifications.
Collection<NotificationPreference>	preferences List of preferences to apply.
org.xwiki.model.reference.DocumentReference	user The user for who we should get the notifications.

Constructor Summary

Constructors

Constructor and Description
NotificationParameters()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

user

public org.xwiki.model.reference.DocumentReference user

The user for who we should get the notifications.

format

public org.xwiki.notifications.NotificationFormat format

The format of the notifications to get.

expectedCount

public int expectedCount

The maximum number of notifications to return.

endDate

public Date endDate

Don't get notifications that have been triggered after the following date.

endDateIncluded

public boolean endDateIncluded

True if the end date should be included.

Since:

12.6.1, 12.7RC1

fromDate

public Date fromDate

Don't get notification that have been triggered before the following date.

onlyUnread

public Boolean onlyUnread

Display only unread notifications.

blackList

public Collection<String> blackList

List of event IDs not to return.

preferences

public Collection<NotificationPreference> preferences

List of preferences to apply.

filterPreferences

public Collection<NotificationFilterPreference> filterPreferences

List of filter preferences to apply.

filters

public Collection<NotificationFilter> filters

List of filters to apply.

Constructor Detail

NotificationParameters

public NotificationParameters()

Method Detail

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object