public class WatchedLocationReference extends Object implements WatchedEntityReference
Constructor and Description |
---|
WatchedLocationReference(org.xwiki.model.reference.EntityReference entityReference,
String serializedReference,
org.xwiki.model.reference.EntityReferenceResolver<String> resolver,
org.xwiki.notifications.filters.internal.scope.ScopeNotificationFilterLocationStateComputer stateComputer,
NotificationFilterPreferenceManager notificationFilterPreferenceManager)
Construct a WatchedLocationReference.
|
Modifier and Type | Method and Description |
---|---|
NotificationFilterPreference |
createExclusiveFilterPreference()
Create a notification filter preference to watch this entity.
|
NotificationFilterPreference |
createInclusiveFilterPreference()
Create a notification filter preference to watch this entity.
|
boolean |
isWatched(org.xwiki.model.reference.DocumentReference userReference) |
boolean |
isWatchedWithAllEventTypes(org.xwiki.model.reference.DocumentReference userReference) |
boolean |
matchExactly(NotificationFilterPreference notificationFilterPreference) |
String |
toString() |
public WatchedLocationReference(org.xwiki.model.reference.EntityReference entityReference, String serializedReference, org.xwiki.model.reference.EntityReferenceResolver<String> resolver, org.xwiki.notifications.filters.internal.scope.ScopeNotificationFilterLocationStateComputer stateComputer, NotificationFilterPreferenceManager notificationFilterPreferenceManager)
entityReference
- the reference of the location to watchserializedReference
- the serialized reference of the location to watchresolver
- the default entity reference resolverstateComputer
- the default ScopeNotificationFilterLocationStateComputernotificationFilterPreferenceManager
- the notification filter preference managerpublic boolean isWatched(org.xwiki.model.reference.DocumentReference userReference) throws org.xwiki.notifications.NotificationException
isWatched
in interface WatchedEntityReference
userReference
- a usertrue
if the given user watch the current entity reference for any event type or format.org.xwiki.notifications.NotificationException
- if an error happenspublic boolean isWatchedWithAllEventTypes(org.xwiki.model.reference.DocumentReference userReference) throws org.xwiki.notifications.NotificationException
isWatchedWithAllEventTypes
in interface WatchedEntityReference
userReference
- a usertrue
if the given user watch the current entity reference for all events.org.xwiki.notifications.NotificationException
- if an error happenspublic boolean matchExactly(NotificationFilterPreference notificationFilterPreference)
matchExactly
in interface WatchedEntityReference
notificationFilterPreference
- a filter preferencepublic NotificationFilterPreference createInclusiveFilterPreference()
WatchedEntityReference
createInclusiveFilterPreference
in interface WatchedEntityReference
public NotificationFilterPreference createExclusiveFilterPreference()
WatchedEntityReference
createExclusiveFilterPreference
in interface WatchedEntityReference
Copyright © 2004–2022 XWiki. All rights reserved.