A B C D E F G H I K L M N O P R S T U V W
All Classes All Packages
All Classes All Packages
All Classes All Packages
A
- AbstractBinaryOperatorNode - Class in org.xwiki.notifications.filters.expression.generics
-
Binary operand node definition for a filtering expression.
- AbstractBinaryOperatorNode(AbstractNode, AbstractNode) - Constructor for class org.xwiki.notifications.filters.expression.generics.AbstractBinaryOperatorNode
-
Constructs a new binary operator node.
- AbstractNode - Class in org.xwiki.notifications.filters.expression.generics
-
AbstractNode definition for a filtering expression.
- AbstractNode() - Constructor for class org.xwiki.notifications.filters.expression.generics.AbstractNode
- AbstractOperatorNode - Class in org.xwiki.notifications.filters.expression.generics
-
Generic operator node definition for filtering expressions.
- AbstractOperatorNode() - Constructor for class org.xwiki.notifications.filters.expression.generics.AbstractOperatorNode
- AbstractUnaryOperatorNode - Class in org.xwiki.notifications.filters.expression.generics
-
Unary operand node definition for a filtering expression.
- AbstractUnaryOperatorNode(AbstractNode) - Constructor for class org.xwiki.notifications.filters.expression.generics.AbstractUnaryOperatorNode
-
Constructs a new
AbstractUnaryOperatorNode
. - AbstractValueNode<T> - Class in org.xwiki.notifications.filters.expression.generics
-
Define a node that contains a specific value accessible with
AbstractValueNode.getContent()
. - AbstractValueNode(T) - Constructor for class org.xwiki.notifications.filters.expression.generics.AbstractValueNode
-
Constructs a new Value Node.
- and(AbstractOperatorNode) - Method in class org.xwiki.notifications.filters.expression.generics.AbstractOperatorNode
-
Helper to construct new
AndNode
using the current object. - AndNode - Class in org.xwiki.notifications.filters.expression
-
Define a AND condition in a filtering expression.
- AndNode(AbstractOperatorNode, AbstractOperatorNode) - Constructor for class org.xwiki.notifications.filters.expression.AndNode
-
Constructs a new AND node.
- APPLICATION - org.xwiki.notifications.filters.expression.EventProperty
-
The application the event belongs to.
- APPLICATION - org.xwiki.notifications.filters.NotificationFilterProperty
-
The notification application.
B
- BODY - org.xwiki.notifications.filters.expression.EventProperty
-
The content of the event.
- BODY - org.xwiki.notifications.filters.NotificationFilterProperty
-
The notification body.
- BooleanValueNode - Class in org.xwiki.notifications.filters.expression
-
Define value node containing a
Boolean
. - BooleanValueNode(boolean) - Constructor for class org.xwiki.notifications.filters.expression.BooleanValueNode
-
Constructs a new Boolean value node.
C
- compareTo(Object) - Method in interface org.xwiki.notifications.filters.NotificationFilter
- concat(AbstractValueNode) - Method in class org.xwiki.notifications.filters.expression.generics.AbstractValueNode
-
Helper that allows to create
ConcatNode
without having to instantiate new objects. - ConcatNode - Class in org.xwiki.notifications.filters.expression
-
Define a CONCAT condition in a filtering expression.
- ConcatNode(AbstractNode, AbstractNode) - Constructor for class org.xwiki.notifications.filters.expression.ConcatNode
-
Constructs a new CONCAT node.
- createScopeFilterPreference(NotificationFilterType, Set<NotificationFormat>, List<String>, EntityReference) - Method in class org.xwiki.notifications.filters.script.NotificationFiltersScriptService
-
Create a scope notification filter preference for the current user.
- createScopeFilterPreference(NotificationFilterType, Set<NotificationFormat>, List<String>, EntityReference, UserReference) - Method in class org.xwiki.notifications.filters.script.NotificationFiltersScriptService
-
Create a scope notification filter preference for the given user.
- createWikiScopeFilterPreference(NotificationFilterType, Set<NotificationFormat>, List<String>, EntityReference, WikiReference) - Method in class org.xwiki.notifications.filters.script.NotificationFiltersScriptService
-
Create a scope notification filter preference for the given user.
D
- DATE - org.xwiki.notifications.filters.expression.EventProperty
-
The date of the event.
- DateValueNode - Class in org.xwiki.notifications.filters.expression
-
Define value node containing a
Date
. - DateValueNode(Date) - Constructor for class org.xwiki.notifications.filters.expression.DateValueNode
-
Constructs a new Date value node.
- deleteFilterPreference(String) - Method in class org.xwiki.notifications.filters.script.NotificationFiltersScriptService
-
Delete a filter preference.
- deleteFilterPreference(String, UserReference) - Method in class org.xwiki.notifications.filters.script.NotificationFiltersScriptService
-
Delete a filter preference for the given user.
- deleteFilterPreference(DocumentReference, String) - Method in interface org.xwiki.notifications.filters.NotificationFilterPreferenceManager
-
Delete a filter preference.
- deleteFilterPreference(DocumentReference, String) - Method in interface org.xwiki.notifications.filters.NotificationFilterPreferenceProvider
-
Delete a filter preference.
- deleteFilterPreference(WikiReference, String) - Method in interface org.xwiki.notifications.filters.NotificationFilterPreferenceManager
-
Delete a filter preference.
- deleteFilterPreference(WikiReference, String) - Method in interface org.xwiki.notifications.filters.NotificationFilterPreferenceProvider
-
Delete a filter preference.
- deleteWikiFilterPreference(String, WikiReference) - Method in class org.xwiki.notifications.filters.script.NotificationFiltersScriptService
-
Delete a filter preference for the given wiki.
- display(NotificationFilter, NotificationFilterPreference) - Method in interface org.xwiki.notifications.filters.NotificationFilterDisplayer
-
Using the given
NotificationFilter
and an associatedNotificationFilterPreference
, display the filter. - displayFilter(NotificationFilter, NotificationFilterPreference) - Method in interface org.xwiki.notifications.filters.NotificationFilterManager
-
Render a
NotificationFilter
using an associatedNotificationFilterPreference
. - displayFilterPreference(NotificationFilter, NotificationFilterPreference) - Method in class org.xwiki.notifications.filters.script.NotificationFiltersScriptService
-
Get a displayable form of the given
NotificationFilterPreference
. - DOCUMENT_VERSION - org.xwiki.notifications.filters.expression.EventProperty
-
The version of the page concerned by the event.
E
- EMPTY_NODE - Static variable in class org.xwiki.notifications.filters.expression.generics.AbstractNode
-
Generic
EmptyNode
that can be used for comparison. - EmptyNode - Class in org.xwiki.notifications.filters.expression
-
Empty node definition for a filtering expression.
- EmptyNode() - Constructor for class org.xwiki.notifications.filters.expression.EmptyNode
- endsWith(AbstractValueNode) - Method in class org.xwiki.notifications.filters.expression.generics.AbstractValueNode
-
Helper that allows to create
EndsWith
without having to instantiate new objects. - EndsWith - Class in org.xwiki.notifications.filters.expression
-
Define a LIKE ("%value") operation in a filtering expression.
- EndsWith(AbstractValueNode, AbstractValueNode) - Constructor for class org.xwiki.notifications.filters.expression.EndsWith
-
Constructs a new EndsWith node.
- EntityReferenceNode - Class in org.xwiki.notifications.filters.expression
-
Define value node containing a
EntityReference
. - EntityReferenceNode(EntityReference) - Constructor for class org.xwiki.notifications.filters.expression.EntityReferenceNode
-
Constructs a new EntityReference value node.
- eq(AbstractValueNode) - Method in class org.xwiki.notifications.filters.expression.generics.AbstractValueNode
-
Helper method used to easily create expressions such as "VALUE1 = VALUE2" without having to instantiate new objects.
- equals(Object) - Method in class org.xwiki.notifications.filters.expression.AndNode
- equals(Object) - Method in class org.xwiki.notifications.filters.expression.BooleanValueNode
- equals(Object) - Method in class org.xwiki.notifications.filters.expression.ConcatNode
- equals(Object) - Method in class org.xwiki.notifications.filters.expression.DateValueNode
- equals(Object) - Method in class org.xwiki.notifications.filters.expression.EmptyNode
- equals(Object) - Method in class org.xwiki.notifications.filters.expression.EndsWith
- equals(Object) - Method in class org.xwiki.notifications.filters.expression.EntityReferenceNode
- equals(Object) - Method in class org.xwiki.notifications.filters.expression.EqualsNode
- equals(Object) - Method in class org.xwiki.notifications.filters.expression.generics.AbstractBinaryOperatorNode
- equals(Object) - Method in class org.xwiki.notifications.filters.expression.generics.AbstractUnaryOperatorNode
- equals(Object) - Method in class org.xwiki.notifications.filters.expression.generics.AbstractValueNode
- equals(Object) - Method in class org.xwiki.notifications.filters.expression.GreaterThanNode
- equals(Object) - Method in class org.xwiki.notifications.filters.expression.InNode
- equals(Object) - Method in class org.xwiki.notifications.filters.expression.InSubQueryNode
- equals(Object) - Method in class org.xwiki.notifications.filters.expression.LesserThanNode
- equals(Object) - Method in class org.xwiki.notifications.filters.expression.NotEqualsNode
- equals(Object) - Method in class org.xwiki.notifications.filters.expression.NotNode
- equals(Object) - Method in class org.xwiki.notifications.filters.expression.OrNode
- equals(Object) - Method in class org.xwiki.notifications.filters.expression.PropertyValueNode
- equals(Object) - Method in class org.xwiki.notifications.filters.expression.StartsWith
- equals(Object) - Method in class org.xwiki.notifications.filters.expression.StringValueNode
- EqualsNode - Class in org.xwiki.notifications.filters.expression
-
Define a EQUALS condition in a filtering expression.
- EqualsNode(AbstractValueNode, AbstractValueNode) - Constructor for class org.xwiki.notifications.filters.expression.EqualsNode
-
Constructs a new EQUALS node.
- EVENT_TYPE - org.xwiki.notifications.filters.NotificationFilterProperty
-
The type of event that triggered the notification.
- EventProperty - Enum in org.xwiki.notifications.filters.expression
-
The several properties you can have in an
Event
. - EXCLUSIVE - org.xwiki.notifications.filters.NotificationFilterType
-
The filter associated with this scope type be exclusive.
- ExpressionBuilder - Class in org.xwiki.notifications.filters.expression.generics
-
Class used to give a couple of helper methods in order to create a filtering expression.
- ExpressionNode - Interface in org.xwiki.notifications.filters.expression
F
- FILTER - org.xwiki.notifications.filters.NotificationFilter.FilterPolicy
-
Value used when the event must be not returned.
- filterEvent(Event, DocumentReference, Collection<NotificationFilterPreference>, NotificationFormat) - Method in interface org.xwiki.notifications.filters.NotificationFilter
-
Enable or disable an event in the notification list (post-filter).
- filterExpression(DocumentReference, Collection<NotificationFilterPreference>, NotificationFilterType, NotificationFormat) - Method in interface org.xwiki.notifications.filters.NotificationFilter
-
Filtering expression to use when retrieving notifications.
- filterExpression(DocumentReference, Collection<NotificationFilterPreference>, NotificationFilterType, NotificationFormat, Collection<NotificationPreference>) - Method in interface org.xwiki.notifications.filters.NotificationFilter
-
Filtering expression to use when retrieving notifications.
- filterExpression(DocumentReference, Collection<NotificationFilterPreference>, NotificationPreference) - Method in interface org.xwiki.notifications.filters.NotificationFilter
-
Filtering expression to use when retrieving notifications.
G
- getAllFilters(boolean) - Method in interface org.xwiki.notifications.filters.NotificationFilterManager
-
Get all notifications filters.
- getAllFilters(DocumentReference, boolean) - Method in interface org.xwiki.notifications.filters.NotificationFilterManager
-
Get all notifications filters that are enabled to the given user.
- getAllFilters(DocumentReference, boolean, NotificationFilter.FilteringPhase) - Method in interface org.xwiki.notifications.filters.NotificationFilterManager
-
Get all notifications filters that are enabled to the given user and matching the requested filtering moment.
- getAllFilters(WikiReference) - Method in interface org.xwiki.notifications.filters.NotificationFilterManager
-
Get all notifications filters from the given wikis.
- getContent() - Method in class org.xwiki.notifications.filters.expression.generics.AbstractValueNode
- getEnabledFilters(Collection<NotificationFilter>, Map<String, Boolean>) - Method in interface org.xwiki.notifications.filters.NotificationFilterManager
-
Goes through every given
NotificationFilter
. - getEventTypes() - Method in interface org.xwiki.notifications.filters.NotificationFilterPreference
- getFilteringPhases() - Method in interface org.xwiki.notifications.filters.NotificationFilter
- getFilterName() - Method in interface org.xwiki.notifications.filters.NotificationFilterPreference
- getFilterPreferences(Collection<NotificationFilterPreference>, NotificationFilter) - Method in interface org.xwiki.notifications.filters.NotificationFilterPreferenceManager
-
Get from the given filter preferences the ones that match the given filter.
- getFilterPreferences(Collection<NotificationFilterPreference>, NotificationFilter, NotificationFilterType) - Method in interface org.xwiki.notifications.filters.NotificationFilterPreferenceManager
-
Get from the given filter preferences the ones that match the given filter and the given filter type.
- getFilterPreferences(Collection<NotificationFilterPreference>, NotificationFilter, NotificationFilterType, NotificationFormat) - Method in interface org.xwiki.notifications.filters.NotificationFilterPreferenceManager
-
Get from the given filter preferences the ones that match the given filter, filter type and format.
- getFilterPreferences(DocumentReference) - Method in interface org.xwiki.notifications.filters.NotificationFilterPreferenceManager
-
Get the notification filter preferences of the given user.
- getFilterPreferences(DocumentReference) - Method in interface org.xwiki.notifications.filters.NotificationFilterPreferenceProvider
-
Get every registered
NotificationFilterPreference
for the given user. - getFilterPreferences(WikiReference) - Method in interface org.xwiki.notifications.filters.NotificationFilterPreferenceManager
-
Get the notification filter preferences of the given wiki.
- getFilterPreferences(WikiReference) - Method in interface org.xwiki.notifications.filters.NotificationFilterPreferenceProvider
-
Get every registered
NotificationFilterPreference
for the given user. - getFilterPreferences(NotificationFilter) - Method in class org.xwiki.notifications.filters.script.NotificationFiltersScriptService
-
Get a collection of notification filters preferences that are available for the current user and that corresponds to the given filter.
- getFilterPreferences(NotificationFilter, UserReference) - Method in class org.xwiki.notifications.filters.script.NotificationFiltersScriptService
-
Get a collection of notification filters preferences that are available for the given user and that corresponds to the given filter.
- getFilters() - Method in class org.xwiki.notifications.filters.script.NotificationFiltersScriptService
- getFilters(UserReference) - Method in class org.xwiki.notifications.filters.script.NotificationFiltersScriptService
- getFiltersRelatedToNotificationPreference(Collection<NotificationFilter>, NotificationPreference) - Method in interface org.xwiki.notifications.filters.NotificationFilterManager
-
Get from the filters the one that match the given notification preference.
- getFilterType() - Method in interface org.xwiki.notifications.filters.NotificationFilterPreference
- getId() - Method in interface org.xwiki.notifications.filters.NotificationFilterPreference
- getLeftOperand() - Method in class org.xwiki.notifications.filters.expression.ConcatNode
- getLeftOperand() - Method in class org.xwiki.notifications.filters.expression.generics.AbstractBinaryOperatorNode
- getLeftOperand() - Method in class org.xwiki.notifications.filters.expression.InNode
- getLeftOperand() - Method in class org.xwiki.notifications.filters.expression.InSubQueryNode
- getName() - Method in interface org.xwiki.notifications.filters.NotificationFilter
-
Get the name of the filter.
- getNotificationFormats() - Method in interface org.xwiki.notifications.filters.NotificationFilterPreference
- getOperand() - Method in class org.xwiki.notifications.filters.expression.generics.AbstractUnaryOperatorNode
- getPage() - Method in interface org.xwiki.notifications.filters.NotificationFilterPreference
- getPageOnly() - Method in interface org.xwiki.notifications.filters.NotificationFilterPreference
- getParameters() - Method in class org.xwiki.notifications.filters.expression.InSubQueryNode
- getPriority() - Method in interface org.xwiki.notifications.filters.NotificationFilter
- getProviderHint() - Method in interface org.xwiki.notifications.filters.NotificationFilterPreference
- getRightOperand() - Method in class org.xwiki.notifications.filters.expression.ConcatNode
- getRightOperand() - Method in class org.xwiki.notifications.filters.expression.generics.AbstractBinaryOperatorNode
- getStartingDate() - Method in interface org.xwiki.notifications.filters.NotificationFilterPreference
- getSubQuery() - Method in class org.xwiki.notifications.filters.expression.InSubQueryNode
- getSupportedFilters() - Method in interface org.xwiki.notifications.filters.NotificationFilterDisplayer
- getToggeableFilterActivations(DocumentReference) - Method in interface org.xwiki.notifications.filters.NotificationFilterManager
-
For all toggeable notification filters, get if the filter is enabled regarding the user profile.
- getToggleableFilters(Collection<NotificationFilter>) - Method in interface org.xwiki.notifications.filters.NotificationFilterManager
-
Get from the given filter the one that are toggleable.
- getToggleableNotificationFilters() - Method in class org.xwiki.notifications.filters.script.NotificationFiltersScriptService
-
Get a set of notification filters that can be toggled by the current user.
- getToggleableNotificationFilters(UserReference) - Method in class org.xwiki.notifications.filters.script.NotificationFiltersScriptService
-
Get a set of notification filters that can be toggled by the given user.
- getUser() - Method in interface org.xwiki.notifications.filters.NotificationFilterPreference
- getValues() - Method in class org.xwiki.notifications.filters.expression.InNode
- getWiki() - Method in interface org.xwiki.notifications.filters.NotificationFilterPreference
- getWikiFilterPreferences(NotificationFilter, WikiReference) - Method in class org.xwiki.notifications.filters.script.NotificationFiltersScriptService
-
Get a collection of notification filters preferences that are available for the given wiki and that corresponds to the given filter.
- getWikiFilters(WikiReference) - Method in class org.xwiki.notifications.filters.script.NotificationFiltersScriptService
-
Get the filters of the given wiki.
- getWikiId() - Method in interface org.xwiki.notifications.filters.NotificationFilterPreference
-
NotificationFilterPreference.getWiki()
,NotificationFilterPreference.getPage()
,NotificationFilterPreference.getPageOnly()
andNotificationFilterPreference.getUser()
are analyzed (in this order) to find the wiki identifier. - getWikiToggleableNotificationFilters(WikiReference) - Method in class org.xwiki.notifications.filters.script.NotificationFiltersScriptService
-
Get a set of notification filters that can be toggled for the given wiki.
- greaterThan(AbstractValueNode) - Method in class org.xwiki.notifications.filters.expression.generics.AbstractValueNode
-
Helper that allows to create
GreaterThanNode
without having to instantiate new objects. - GreaterThanNode - Class in org.xwiki.notifications.filters.expression
-
Define a >= condition in a filtering expression.
- GreaterThanNode(AbstractValueNode, AbstractValueNode) - Constructor for class org.xwiki.notifications.filters.expression.GreaterThanNode
-
Constructs a new ">=" node.
- GreaterThanNode(AbstractValueNode, AbstractValueNode, boolean) - Constructor for class org.xwiki.notifications.filters.expression.GreaterThanNode
-
Constructs a new "<=" node.
- GROUP_ID - org.xwiki.notifications.filters.expression.EventProperty
-
The group ID of the event.
H
- hashCode() - Method in class org.xwiki.notifications.filters.expression.AndNode
- hashCode() - Method in class org.xwiki.notifications.filters.expression.BooleanValueNode
- hashCode() - Method in class org.xwiki.notifications.filters.expression.ConcatNode
- hashCode() - Method in class org.xwiki.notifications.filters.expression.DateValueNode
- hashCode() - Method in class org.xwiki.notifications.filters.expression.EmptyNode
- hashCode() - Method in class org.xwiki.notifications.filters.expression.EndsWith
- hashCode() - Method in class org.xwiki.notifications.filters.expression.EntityReferenceNode
- hashCode() - Method in class org.xwiki.notifications.filters.expression.EqualsNode
- hashCode() - Method in class org.xwiki.notifications.filters.expression.generics.AbstractBinaryOperatorNode
- hashCode() - Method in class org.xwiki.notifications.filters.expression.generics.AbstractUnaryOperatorNode
- hashCode() - Method in class org.xwiki.notifications.filters.expression.generics.AbstractValueNode
- hashCode() - Method in class org.xwiki.notifications.filters.expression.GreaterThanNode
- hashCode() - Method in class org.xwiki.notifications.filters.expression.InNode
- hashCode() - Method in class org.xwiki.notifications.filters.expression.InSubQueryNode
- hashCode() - Method in class org.xwiki.notifications.filters.expression.LesserThanNode
- hashCode() - Method in class org.xwiki.notifications.filters.expression.NotEqualsNode
- hashCode() - Method in class org.xwiki.notifications.filters.expression.NotNode
- hashCode() - Method in class org.xwiki.notifications.filters.expression.OrNode
- hashCode() - Method in class org.xwiki.notifications.filters.expression.PropertyValueNode
- hashCode() - Method in class org.xwiki.notifications.filters.expression.StartsWith
- hashCode() - Method in class org.xwiki.notifications.filters.expression.StringValueNode
- HIDDEN - org.xwiki.notifications.filters.expression.EventProperty
-
Either of the event is hidden or not.
- HIDDEN - org.xwiki.notifications.filters.NotificationFilterProperty
-
Is the document focused by the notification hidden ?
I
- ID - org.xwiki.notifications.filters.expression.EventProperty
-
The ID of the event.
- IMPORTANCE - org.xwiki.notifications.filters.expression.EventProperty
-
The importance of the event.
- in(Collection<AbstractValueNode>) - Method in class org.xwiki.notifications.filters.expression.generics.AbstractValueNode
-
Helper that allows to create
InNode
without having to instantiate new objects. - INCLUSIVE - org.xwiki.notifications.filters.NotificationFilterType
-
This is the default type, the filter associated with this type will be inclusive.
- InNode - Class in org.xwiki.notifications.filters.expression
-
Define a IN operation in a filtering expression.
- InNode(AbstractValueNode, Collection<AbstractValueNode>) - Constructor for class org.xwiki.notifications.filters.expression.InNode
-
Construct an IN operation node.
- inStrings(Collection<String>) - Method in class org.xwiki.notifications.filters.expression.generics.AbstractValueNode
-
Helper that allows to create
InNode
without having to instantiate new objects. - inSubQuery(String, Map<String, Object>) - Method in class org.xwiki.notifications.filters.expression.generics.AbstractValueNode
-
Helper that allows to create
InSubQueryNode
without having to instantiate new objects. - InSubQueryNode - Class in org.xwiki.notifications.filters.expression
-
Define a IN operation into a given sub query in a filtering expression.
- InSubQueryNode(AbstractValueNode, String, Map<String, Object>) - Constructor for class org.xwiki.notifications.filters.expression.InSubQueryNode
-
Construct an IN operation node.
- isActive() - Method in interface org.xwiki.notifications.filters.NotificationFilterPreference
-
A filter preference can either be active or passive.
- isEnabled() - Method in interface org.xwiki.notifications.filters.NotificationFilterPreference
- isFromWiki(String) - Method in interface org.xwiki.notifications.filters.NotificationFilterPreference
-
Return
true
if the filter preference is related to a given wiki. - isOrEquals() - Method in class org.xwiki.notifications.filters.expression.GreaterThanNode
- isOrEquals() - Method in class org.xwiki.notifications.filters.expression.LesserThanNode
K
- KEEP - org.xwiki.notifications.filters.NotificationFilter.FilterPolicy
-
Value used when the event must be kept.
L
- lesserThan(AbstractValueNode) - Method in class org.xwiki.notifications.filters.expression.generics.AbstractValueNode
-
Helper that allows to create
LesserThanNode
without having to instantiate new objects. - LesserThanNode - Class in org.xwiki.notifications.filters.expression
-
Define a "<=" condition in a filtering expression.
- LesserThanNode(AbstractValueNode, AbstractValueNode) - Constructor for class org.xwiki.notifications.filters.expression.LesserThanNode
-
Constructs a new "<=" node.
- LesserThanNode(AbstractValueNode, AbstractValueNode, boolean) - Constructor for class org.xwiki.notifications.filters.expression.LesserThanNode
-
Constructs a new "<=" node.
M
- matchesPreference(NotificationPreference) - Method in interface org.xwiki.notifications.filters.NotificationFilter
-
Determine if the current filter can be applied to the given preference.
N
- NO_EFFECT - org.xwiki.notifications.filters.NotificationFilter.FilterPolicy
-
Value used when the filter has no impact on the given event.
- not(AbstractOperatorNode) - Static method in class org.xwiki.notifications.filters.expression.generics.ExpressionBuilder
-
Instantiate a new
NotNode
using the given value. - notEq(AbstractValueNode) - Method in class org.xwiki.notifications.filters.expression.generics.AbstractValueNode
-
Just as
AbstractValueNode.eq(AbstractValueNode)
, this method is a helper to create expressions without having to instantiate new objects. - NotEqualsNode - Class in org.xwiki.notifications.filters.expression
-
Define a NOT EQUALS condition in a filtering expression.
- NotEqualsNode(AbstractValueNode, AbstractValueNode) - Constructor for class org.xwiki.notifications.filters.expression.NotEqualsNode
-
Constructs a new NOT EQUALS node.
- NotificationFilter - Interface in org.xwiki.notifications.filters
-
Enable or disable notifications from the event stream (for customization purpose).
- NotificationFilter.FilteringPhase - Enum in org.xwiki.notifications.filters
-
The different phases when a filter can be called.
- NotificationFilter.FilterPolicy - Enum in org.xwiki.notifications.filters
-
The different behaviours a filter could have regarding an event.
- NotificationFilterDisplayer - Interface in org.xwiki.notifications.filters
-
This interface can be used to display a given notification filter with a corresponding preference.
- NotificationFilterManager - Interface in org.xwiki.notifications.filters
-
Provide an interface for interacting with user notification filters.
- NotificationFilterPreference - Interface in org.xwiki.notifications.filters
-
Define the preference of a notification filter.
- NotificationFilterPreferenceManager - Interface in org.xwiki.notifications.filters
-
Provide an interface for interacting with user notification filters preferences.
- NotificationFilterPreferenceProvider - Interface in org.xwiki.notifications.filters
-
Provide
NotificationFilterPreference
from multiple sources. - NotificationFilterProperty - Enum in org.xwiki.notifications.filters
-
Define a list of properties supported by
PropertyValueNode
. - NotificationFiltersScriptService - Class in org.xwiki.notifications.filters.script
-
Script service for the notification filters.
- NotificationFiltersScriptService() - Constructor for class org.xwiki.notifications.filters.script.NotificationFiltersScriptService
- NotificationFilterType - Enum in org.xwiki.notifications.filters
-
Determine the filter type of an
NotificationFilter
. - NotNode - Class in org.xwiki.notifications.filters.expression
-
Define a NOT operation in a filtering expression.
- NotNode(AbstractOperatorNode) - Constructor for class org.xwiki.notifications.filters.expression.NotNode
-
Constructs a new NOT node.
O
- or(AbstractOperatorNode) - Method in class org.xwiki.notifications.filters.expression.generics.AbstractOperatorNode
-
Helper to construct new
OrNode
using the current object. - org.xwiki.notifications.filters - package org.xwiki.notifications.filters
- org.xwiki.notifications.filters.expression - package org.xwiki.notifications.filters.expression
- org.xwiki.notifications.filters.expression.generics - package org.xwiki.notifications.filters.expression.generics
- org.xwiki.notifications.filters.script - package org.xwiki.notifications.filters.script
- OrNode - Class in org.xwiki.notifications.filters.expression
-
Define a OR condition in a filtering expression.
- OrNode(AbstractOperatorNode, AbstractOperatorNode) - Constructor for class org.xwiki.notifications.filters.expression.OrNode
-
Constructs a new OR node.
P
- PAGE - org.xwiki.notifications.filters.expression.EventProperty
-
The page concerned by the event.
- PAGE - org.xwiki.notifications.filters.NotificationFilterProperty
-
Page targeted by the notification.
- POST_FILTERING - org.xwiki.notifications.filters.NotificationFilter.FilteringPhase
-
If the filter is used during post-filtering.
- PRE_FILTERING - org.xwiki.notifications.filters.NotificationFilter.FilteringPhase
-
If the filter is used during pre-filtering.
- PRIORITY - org.xwiki.notifications.filters.NotificationFilterProperty
-
Priority of the event that triggered the notification.
- PropertyValueNode - Class in org.xwiki.notifications.filters.expression
-
Define value node containing a
NotificationFilterProperty
. - PropertyValueNode(EventProperty) - Constructor for class org.xwiki.notifications.filters.expression.PropertyValueNode
-
Constructs a new value node using
NotificationFilterProperty
.
R
- REMOTE_OBSERVATION_ID - org.xwiki.notifications.filters.expression.EventProperty
-
The unique identifier of the instance in the cluster.
S
- saveFilterPreferences(DocumentReference, Set<NotificationFilterPreference>) - Method in interface org.xwiki.notifications.filters.NotificationFilterPreferenceManager
-
Save the given set of
NotificationFilterPreference
against their respectiveNotificationFilterPreferenceProvider
. - saveFilterPreferences(DocumentReference, Set<NotificationFilterPreference>) - Method in interface org.xwiki.notifications.filters.NotificationFilterPreferenceProvider
-
Save a given set of filter preferences.
- setEnabled(boolean) - Method in interface org.xwiki.notifications.filters.NotificationFilterPreference
- setFilterPreferenceEnabled(String, boolean) - Method in class org.xwiki.notifications.filters.script.NotificationFiltersScriptService
-
Enable or disable a filter preference.
- setFilterPreferenceEnabled(String, boolean, UserReference) - Method in class org.xwiki.notifications.filters.script.NotificationFiltersScriptService
-
Enable or disable a filter preference.
- setFilterPreferenceEnabled(DocumentReference, String, boolean) - Method in interface org.xwiki.notifications.filters.NotificationFilterPreferenceManager
-
Enable or disable a filter preference.
- setFilterPreferenceEnabled(DocumentReference, String, boolean) - Method in interface org.xwiki.notifications.filters.NotificationFilterPreferenceProvider
-
Enable or disable a filter preference.
- setFilterPreferenceEnabled(WikiReference, String, boolean) - Method in interface org.xwiki.notifications.filters.NotificationFilterPreferenceManager
-
Enable or disable a filter preference.
- setFilterPreferenceEnabled(WikiReference, String, boolean) - Method in interface org.xwiki.notifications.filters.NotificationFilterPreferenceProvider
-
Enable or disable a filter preference.
- setStartDate(Date) - Method in class org.xwiki.notifications.filters.script.NotificationFiltersScriptService
-
Update the start date for every filter preference that current user has.
- setStartDate(Date, UserReference) - Method in class org.xwiki.notifications.filters.script.NotificationFiltersScriptService
-
Update the start date for every filter preference that given user has.
- setStartDateForUser(DocumentReference, Date) - Method in interface org.xwiki.notifications.filters.NotificationFilterPreferenceManager
-
Update the start date for every filter preference that the user has.
- setStartDateForUser(DocumentReference, Date) - Method in interface org.xwiki.notifications.filters.NotificationFilterPreferenceProvider
-
Update the start date for every notification preference that the user has.
- setWikiFilterPreferenceEnabled(String, boolean, WikiReference) - Method in class org.xwiki.notifications.filters.script.NotificationFiltersScriptService
-
Enable or disable a filter preference.
- SPACE - org.xwiki.notifications.filters.expression.EventProperty
-
The space concerned by the event.
- SPACE - org.xwiki.notifications.filters.NotificationFilterProperty
-
The space targeted by the notification.
- startsWith(AbstractValueNode) - Method in class org.xwiki.notifications.filters.expression.generics.AbstractValueNode
-
Helper that allows to create
StartsWith
without having to instantiate new objects. - StartsWith - Class in org.xwiki.notifications.filters.expression
-
Define a LIKE ("value_%") operation in a filtering expression.
- StartsWith(AbstractValueNode, AbstractValueNode) - Constructor for class org.xwiki.notifications.filters.expression.StartsWith
-
Constructs a new StartsWith node.
- STREAM - org.xwiki.notifications.filters.expression.EventProperty
-
The stream the event belongs to.
- StringValueNode - Class in org.xwiki.notifications.filters.expression
-
Define value node containing a
String
. - StringValueNode(String) - Constructor for class org.xwiki.notifications.filters.expression.StringValueNode
-
Constructs a new String value node.
- SUPPORT_BOTH_FILTERING_PHASE - Static variable in interface org.xwiki.notifications.filters.NotificationFilter
-
A static set containing both
NotificationFilter.FilteringPhase.POST_FILTERING
andNotificationFilter.FilteringPhase.PRE_FILTERING
. - SUPPORT_ONLY_POST_FILTERING_PHASE - Static variable in interface org.xwiki.notifications.filters.NotificationFilter
-
A static set containing only
NotificationFilter.FilteringPhase.POST_FILTERING
. - SUPPORT_ONLY_PRE_FILTERING_PHASE - Static variable in interface org.xwiki.notifications.filters.NotificationFilter
-
A static set containing only
NotificationFilter.FilteringPhase.PRE_FILTERING
.
T
- TITLE - org.xwiki.notifications.filters.expression.EventProperty
-
The title of the page concerned by the event.
- TITLE - org.xwiki.notifications.filters.NotificationFilterProperty
-
The title of the notification.
- toString() - Method in class org.xwiki.notifications.filters.expression.AndNode
- toString() - Method in class org.xwiki.notifications.filters.expression.BooleanValueNode
- toString() - Method in class org.xwiki.notifications.filters.expression.ConcatNode
- toString() - Method in class org.xwiki.notifications.filters.expression.DateValueNode
- toString() - Method in class org.xwiki.notifications.filters.expression.EmptyNode
- toString() - Method in class org.xwiki.notifications.filters.expression.EndsWith
- toString() - Method in class org.xwiki.notifications.filters.expression.EntityReferenceNode
- toString() - Method in class org.xwiki.notifications.filters.expression.EqualsNode
- toString() - Method in class org.xwiki.notifications.filters.expression.GreaterThanNode
- toString() - Method in class org.xwiki.notifications.filters.expression.InNode
- toString() - Method in class org.xwiki.notifications.filters.expression.InSubQueryNode
- toString() - Method in class org.xwiki.notifications.filters.expression.LesserThanNode
- toString() - Method in class org.xwiki.notifications.filters.expression.NotEqualsNode
- toString() - Method in class org.xwiki.notifications.filters.expression.NotNode
- toString() - Method in class org.xwiki.notifications.filters.expression.OrNode
- toString() - Method in class org.xwiki.notifications.filters.expression.PropertyValueNode
- toString() - Method in class org.xwiki.notifications.filters.expression.StartsWith
- toString() - Method in class org.xwiki.notifications.filters.expression.StringValueNode
- TYPE - org.xwiki.notifications.filters.expression.EventProperty
-
The type of the event.
U
- URL - org.xwiki.notifications.filters.expression.EventProperty
-
The URL of the page concerned by the event.
- USER - org.xwiki.notifications.filters.expression.EventProperty
-
The user who created the event.
- USER - org.xwiki.notifications.filters.NotificationFilterProperty
-
The user targeted by the notification.
V
- value(String) - Static method in class org.xwiki.notifications.filters.expression.generics.ExpressionBuilder
-
Instantiate a new
StringValueNode
using the given value. - value(Date) - Static method in class org.xwiki.notifications.filters.expression.generics.ExpressionBuilder
-
Instantiate a new
DateValueNode
using the given value. - value(EntityReference) - Static method in class org.xwiki.notifications.filters.expression.generics.ExpressionBuilder
-
Instantiate a new
EntityReferenceNode
using the given value. - value(EventProperty) - Static method in class org.xwiki.notifications.filters.expression.generics.ExpressionBuilder
-
Instantiate a new
PropertyValueNode
using the given property. - valueOf(String) - Static method in enum org.xwiki.notifications.filters.expression.EventProperty
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.xwiki.notifications.filters.NotificationFilter.FilteringPhase
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.xwiki.notifications.filters.NotificationFilter.FilterPolicy
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.xwiki.notifications.filters.NotificationFilterProperty
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.xwiki.notifications.filters.NotificationFilterType
-
Returns the enum constant of this type with the specified name.
- values() - Static method in enum org.xwiki.notifications.filters.expression.EventProperty
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.xwiki.notifications.filters.NotificationFilter.FilteringPhase
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.xwiki.notifications.filters.NotificationFilter.FilterPolicy
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.xwiki.notifications.filters.NotificationFilterProperty
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.xwiki.notifications.filters.NotificationFilterType
-
Returns an array containing the constants of this enum type, in the order they are declared.
W
- WIKI - org.xwiki.notifications.filters.expression.EventProperty
-
The wiki concerned by the event.
- WIKI - org.xwiki.notifications.filters.NotificationFilterProperty
-
The wiki in which the notification occurred.
All Classes All Packages