org.xwiki.platform.notifications.test.po.preferences.filters

Class NotificationFilterPreference

java.lang.Object

org.xwiki.platform.notifications.test.po.preferences.filters.NotificationFilterPreference

public class NotificationFilterPreference
extends Object

Represent a livetable row describing a notification filter preference.

Since:

10.8RC1, 9.11.8

Version:

$Id: daa408e464796279d937e098c329b76e5b5acf70 $

Constructor Summary

Constructors

Constructor and Description
NotificationFilterPreference(NotificationsUserProfilePage parentPage, org.openqa.selenium.WebElement webElement, XWikiWebDriver driver) Construct a NotificationFilterPreference.

Method Summary

Modifier and Type	Method and Description
void	delete() Delete the filter preference.
List<String>	getEventTypes()
String	getFilterName()
String	getFilterType()
List<String>	getFormats()
String	getLocation()
boolean	isEnabled()
void	setEnabled(boolean enabled) Enable or disable the current filter.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

NotificationFilterPreference

public NotificationFilterPreference(NotificationsUserProfilePage parentPage,
                                    org.openqa.selenium.WebElement webElement,
                                    XWikiWebDriver driver)

Construct a NotificationFilterPreference.

Parameters:

parentPage - the user profile's page holding the livetable.

webElement - the livetable row

driver - the current webdriver in used

Method Detail

getFilterName

public String getFilterName()

Returns:

the name of the filter

getFilterType

public String getFilterType()

Returns:

the type of the filter

getEventTypes

public List<String> getEventTypes()

Returns:

the event types concerned by the filters (empty means "all").

getFormats

public List<String> getFormats()

Returns:

the formats concerned by the filter

isEnabled

public boolean isEnabled()

Returns:

either or not the preference is enabled

setEnabled

public void setEnabled(boolean enabled)
                throws Exception

Enable or disable the current filter.

Parameters:

enabled - either or not the filter must be enabled

Throws:

Exception - if the expected state cannot be set

getLocation

public String getLocation()

Returns:

the watched location if the current filter is a ScopeNotificationFilter.

delete

public void delete()

Delete the filter preference.

toString

public String toString()

Overrides:

toString in class Object