Package de.willuhn.jameica.reminder
Class Reminder
java.lang.Object
de.willuhn.jameica.reminder.Reminder
- All Implemented Interfaces:
Serializable
Ein einzelner Reminder.
Das Erstellen und Speichern des Reminders geschieht beispielhaft so:
String channel = "mein.test.channel";
Date due = new Date(System.currentTimeMillis() + (7 * 24 * 60 * 60 * 1000L));
Map<String,Serializable> data = new HashMap<String,Serializable>();
data.put("foo","bar");
data.put("bar",1);
Reminder reminder = new Reminder(channel,due,data);
ReminderService service = (ReminderService) Application.getBootloader().getBootable(ReminderService.class);
String uuid = service.getDefaultProvider().add(reminder);
Die UUID kann verwendet werden, um den Reminder zu loeschen, bevor er ausgeloest wird.
Bei Erreichen der Faelligkeit sendet der Reminder-Service eine QueryMessage
mit den Nutzdaten an den angegebenen Channel.- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
Key, in dem der Reminder-Service das Datum speichert, an dem der Reminder ausgefuehrt wurde.static final String
Key, in dem der Reminder-Service speichert, wann ein zyklischer Reminder als abgelaufen markiert wurde, weil er ein Ende-Datum besitzt und dieses ueberschritten ist.static final String
Name der Default-Queue, die verwendet wird, wenn keine angegeben wurde. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptiongetData()
Liefert die Map mit den Nutzdaten.Liefert die Nutzdaten zu dem angegebenen Schluessel.getDate()
Liefert den Termin, an dem die Message verschickt werden soll.getEnd()
Liefert ein optionales Ende-Datum bei sich wiederholenden Remindern.getQueue()
Liefert die Queue, an die die Message geschickt werden soll.Optionale Angabe eines Intervalls, falls die Ausfuehrung zyklisch wiederholt werden soll.void
setData
(String key, Serializable data) Speichert Nutzdaten zu dem angegebenen Schluessel.void
setData
(Map<String, Serializable> data) Speichert die Map mit den Nutzdaten.void
Speichert den Termin, an dem die Message verschickt werden soll.void
Speichert ein optionales Ende-Datum bei sich wiederholenden Remindern.void
Speichert die Queue, an den die Message geschickt werden soll.void
setReminderInterval
(ReminderInterval interval) Legt ein optionales Intervall fest, in dem der Reminder wiederholt werden soll.toString()
-
Field Details
-
QUEUE_DEFAULT
Name der Default-Queue, die verwendet wird, wenn keine angegeben wurde.- See Also:
-
KEY_EXECUTED
Key, in dem der Reminder-Service das Datum speichert, an dem der Reminder ausgefuehrt wurde.- See Also:
-
KEY_EXPIRED
Key, in dem der Reminder-Service speichert, wann ein zyklischer Reminder als abgelaufen markiert wurde, weil er ein Ende-Datum besitzt und dieses ueberschritten ist.- See Also:
-
-
Constructor Details
-
Reminder
public Reminder()
-
-
Method Details
-
getQueue
Liefert die Queue, an die die Message geschickt werden soll.- Returns:
- die Queue.
-
setQueue
Speichert die Queue, an den die Message geschickt werden soll.- Parameters:
queue
- die Queue.
-
getDate
Liefert den Termin, an dem die Message verschickt werden soll.- Returns:
- Faelligkeitsdatum.
-
setDate
Speichert den Termin, an dem die Message verschickt werden soll.- Parameters:
due
- der Termin.
-
getReminderInterval
Optionale Angabe eines Intervalls, falls die Ausfuehrung zyklisch wiederholt werden soll.- Returns:
- optionale Angabe eines Intervalls oder NULL, wenn der Reminder nur einmal ausgefuhert wird.
-
setReminderInterval
Legt ein optionales Intervall fest, in dem der Reminder wiederholt werden soll. Ist keines angegeben, wird der Reminder nur einmal ausgefuehrt.- Parameters:
interval
- das Intervall.
-
getEnd
Liefert ein optionales Ende-Datum bei sich wiederholenden Remindern.- Returns:
- optionales Ende-Datum.
-
setEnd
Speichert ein optionales Ende-Datum bei sich wiederholenden Remindern.- Parameters:
end
- optionales Ende-Datum.
-
getData
Liefert die Nutzdaten zu dem angegebenen Schluessel.- Parameters:
key
- der Schluessel.- Returns:
- die Nutzdaten.
-
getData
Liefert die Map mit den Nutzdaten.- Returns:
- die Map mit den Nutzdaten.
-
setData
Speichert die Map mit den Nutzdaten.- Parameters:
data
- die Map mit den Nutzdaten.
-
setData
Speichert Nutzdaten zu dem angegebenen Schluessel.- Parameters:
key
- der Schluessel.data
- die Nutzdaten.
-
toString
-