org.xwiki.notifications.filters

Interface NotificationFilterDisplayer

@Role
public interface NotificationFilterDisplayer

This interface can be used to display a given notification filter with a corresponding preference.

Since:

9.7RC1

Version:

$Id: 899666cdc6463a26dea95915d43b97ad6eccd1f2 $

Method Summary

Modifier and Type	Method and Description
org.xwiki.rendering.block.Block	display(NotificationFilter filter, NotificationFilterPreference preference) Using the given NotificationFilter and an associated NotificationFilterPreference, display the filter.
Set<String>	getSupportedFilters()

Method Detail

display

org.xwiki.rendering.block.Block display(NotificationFilter filter,
                                        NotificationFilterPreference preference)
                                 throws NotificationException

Using the given NotificationFilter and an associated NotificationFilterPreference, display the filter.

Parameters:

filter - the filter that should be displayed

preference - the preferences that should be used for rendering the block

Returns:

the rendered form of the given filter

Throws:

NotificationException - if error occurs

getSupportedFilters

Set<String> getSupportedFilters()

Returns:

a set of NotificationFilter names that are supported by the displayer.