Interface TargetableNotificationPreferenceBuilder
-
@Role public interface TargetableNotificationPreferenceBuilder
Allows to build newTargetableNotificationPreference
.- Since:
- 9.7RC1
- Version:
- $Id: 602b3628985f94491d37fc1ce93f9286e3f2158c $
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description TargetableNotificationPreference
build()
TargetableNotificationPreferenceBuilder
prepare()
Prepare the builder for a new instance.TargetableNotificationPreferenceBuilder
setCategory(NotificationPreferenceCategory category)
TargetableNotificationPreferenceBuilder
setEnabled(boolean isEnabled)
Define if the notification preference is enabled or not.TargetableNotificationPreferenceBuilder
setFormat(NotificationFormat format)
TargetableNotificationPreferenceBuilder
setProperties(Map<NotificationPreferenceProperty,Object> properties)
TargetableNotificationPreferenceBuilder
setProviderHint(String providerHint)
TargetableNotificationPreferenceBuilder
setStartDate(Date startDate)
TargetableNotificationPreferenceBuilder
setTarget(org.xwiki.model.reference.EntityReference target)
-
-
-
Method Detail
-
build
TargetableNotificationPreference build()
- Returns:
- a freshly instanciated
TargetableNotificationPreference
-
prepare
TargetableNotificationPreferenceBuilder prepare()
Prepare the builder for a new instance.- Returns:
- the current instance.
-
setEnabled
TargetableNotificationPreferenceBuilder setEnabled(boolean isEnabled)
Define if the notification preference is enabled or not.- Parameters:
isEnabled
- true if the preference should be enabled- Returns:
- the current instance.
-
setFormat
TargetableNotificationPreferenceBuilder setFormat(NotificationFormat format)
- Parameters:
format
- the format of the preference- Returns:
- the current instance.
-
setProperties
TargetableNotificationPreferenceBuilder setProperties(Map<NotificationPreferenceProperty,Object> properties)
- Parameters:
properties
- a map of the preference properties- Returns:
- the current instance.
-
setProviderHint
TargetableNotificationPreferenceBuilder setProviderHint(String providerHint)
- Parameters:
providerHint
- the hint of the provider of the preference- Returns:
- the current instance.
-
setStartDate
TargetableNotificationPreferenceBuilder setStartDate(Date startDate)
- Parameters:
startDate
- the start date of the preference- Returns:
- the current instance.
-
setTarget
TargetableNotificationPreferenceBuilder setTarget(org.xwiki.model.reference.EntityReference target)
- Parameters:
target
- the target of the preference- Returns:
- the current instance.
- Since:
- 9.11.4, 10.2RC2
-
setCategory
TargetableNotificationPreferenceBuilder setCategory(NotificationPreferenceCategory category)
- Parameters:
category
- the category of the preference- Returns:
- the current instance.
-
-