Package org.silverpeas.core.reminder
Interface BackgroundReminderProcess
-
- All Known Implementing Classes:
CalendarEventUserNotificationReminder
public interface BackgroundReminderProcess
Each scheduled reminder is linked to a process which must be performed when the reminder is triggered.
The linked process must be an implementation of this interface.Each implementation of this interface MUST observe the following convention of
Named
annotation naming :[PROCESS NAME][PROCESS NAME SUFFIX]
CalendarEventUserNotificationReminderProcess
for example, whereCalendarEventUserNotification
is the process name andReminderProcess
the process name suffix.- Author:
- silveryocha
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static class
BackgroundReminderProcess.Constants
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description ReminderProcessName
getName()
Gets theReminderProcessName
instance representing the name of theBackgroundReminderProcess
.void
performWith(Reminder reminder)
Performs the treatment of the process.
-
-
-
Method Detail
-
getName
ReminderProcessName getName()
Gets theReminderProcessName
instance representing the name of theBackgroundReminderProcess
.- Returns:
- the
ReminderProcessName
instance.
-
performWith
void performWith(Reminder reminder)
Performs the treatment of the process.- Parameters:
reminder
- a reminder.
-
-