Interface NotificationPreference
-
- All Known Subinterfaces:
TargetableNotificationPreference
public interface NotificationPreference
Represent a preference set by a user concerning a notification. As we cannot define a Notification by itself as an object,getProperties()
can be used to recover a set of attributes that describe the kind of notification on which thisNotificationPreference
should apply. Note that aNotificationPreference
should be self-sufficient, therefore, it should contain every information needed about what it does. A preference is defined for a category of event, since a specific date and in a given format.- Since:
- 9.2RC1
- Version:
- $Id: e979b406a36b90185234a5dd228d895ad8410511 $
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description NotificationPreferenceCategory
getCategory()
NotificationFormat
getFormat()
Map<NotificationPreferenceProperty,Object>
getProperties()
String
getProviderHint()
The provider linked to aNotificationPreference
is helpful as it permits theNotificationPreferenceManager
to know where to save a given preference.Date
getStartDate()
boolean
isNotificationEnabled()
-
-
-
Method Detail
-
isNotificationEnabled
boolean isNotificationEnabled()
- Returns:
- either or not the notification is enabled for the event type or the application
-
getFormat
NotificationFormat getFormat()
- Returns:
- format of the notification
- Since:
- 9.5RC1
-
getStartDate
Date getStartDate()
- Returns:
- the date from which notifications that match this preference should be retrieved
- Since:
- 9.7RC1
-
getProperties
Map<NotificationPreferenceProperty,Object> getProperties()
- Returns:
- the properties of the given notification preference
- Since:
- 9.7RC1
-
getProviderHint
String getProviderHint()
The provider linked to aNotificationPreference
is helpful as it permits theNotificationPreferenceManager
to know where to save a given preference.- Returns:
- the hint of the provider that the preference comes from. If no provider is defined, returns null.
- Since:
- 9.7RC1
-
getCategory
NotificationPreferenceCategory getCategory()
- Returns:
- the category of the
NotificationPreference
-
-