Package de.willuhn.jameica.reminder
Class Reminder
- java.lang.Object
-
- de.willuhn.jameica.reminder.Reminder
-
- All Implemented Interfaces:
java.io.Serializable
public final class Reminder extends java.lang.Object implements java.io.Serializable
Ein einzelner Reminder. Das Erstellen und Speichern des Reminders geschieht beispielhaft so:
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.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);
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
KEY_EXECUTED
Key, in dem der Reminder-Service das Datum speichert, an dem der Reminder ausgefuehrt wurde.static java.lang.String
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.static java.lang.String
QUEUE_DEFAULT
Name der Default-Queue, die verwendet wird, wenn keine angegeben wurde.
-
Constructor Summary
Constructors Constructor Description Reminder()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.util.Map<java.lang.String,java.io.Serializable>
getData()
Liefert die Map mit den Nutzdaten.java.io.Serializable
getData(java.lang.String key)
Liefert die Nutzdaten zu dem angegebenen Schluessel.java.util.Date
getDate()
Liefert den Termin, an dem die Message verschickt werden soll.java.util.Date
getEnd()
Liefert ein optionales Ende-Datum bei sich wiederholenden Remindern.java.lang.String
getQueue()
Liefert die Queue, an die die Message geschickt werden soll.ReminderInterval
getReminderInterval()
Optionale Angabe eines Intervalls, falls die Ausfuehrung zyklisch wiederholt werden soll.void
setData(java.lang.String key, java.io.Serializable data)
Speichert Nutzdaten zu dem angegebenen Schluessel.void
setData(java.util.Map<java.lang.String,java.io.Serializable> data)
Speichert die Map mit den Nutzdaten.void
setDate(java.util.Date due)
Speichert den Termin, an dem die Message verschickt werden soll.void
setEnd(java.util.Date end)
Speichert ein optionales Ende-Datum bei sich wiederholenden Remindern.void
setQueue(java.lang.String queue)
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.java.lang.String
toString()
-
-
-
Field Detail
-
QUEUE_DEFAULT
public static final java.lang.String QUEUE_DEFAULT
Name der Default-Queue, die verwendet wird, wenn keine angegeben wurde.- See Also:
- Constant Field Values
-
KEY_EXECUTED
public static final java.lang.String KEY_EXECUTED
Key, in dem der Reminder-Service das Datum speichert, an dem der Reminder ausgefuehrt wurde.- See Also:
- Constant Field Values
-
KEY_EXPIRED
public static final java.lang.String 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:
- Constant Field Values
-
-
Method Detail
-
getQueue
public java.lang.String getQueue()
Liefert die Queue, an die die Message geschickt werden soll.- Returns:
- die Queue.
-
setQueue
public void setQueue(java.lang.String queue)
Speichert die Queue, an den die Message geschickt werden soll.- Parameters:
queue
- die Queue.
-
getDate
public java.util.Date getDate()
Liefert den Termin, an dem die Message verschickt werden soll.- Returns:
- Faelligkeitsdatum.
-
setDate
public void setDate(java.util.Date due)
Speichert den Termin, an dem die Message verschickt werden soll.- Parameters:
due
- der Termin.
-
getReminderInterval
public ReminderInterval 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
public void setReminderInterval(ReminderInterval interval)
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
public java.util.Date getEnd()
Liefert ein optionales Ende-Datum bei sich wiederholenden Remindern.- Returns:
- optionales Ende-Datum.
-
setEnd
public void setEnd(java.util.Date end)
Speichert ein optionales Ende-Datum bei sich wiederholenden Remindern.- Parameters:
end
- optionales Ende-Datum.
-
getData
public java.io.Serializable getData(java.lang.String key)
Liefert die Nutzdaten zu dem angegebenen Schluessel.- Parameters:
key
- der Schluessel.- Returns:
- die Nutzdaten.
-
getData
public java.util.Map<java.lang.String,java.io.Serializable> getData()
Liefert die Map mit den Nutzdaten.- Returns:
- die Map mit den Nutzdaten.
-
setData
public void setData(java.util.Map<java.lang.String,java.io.Serializable> data)
Speichert die Map mit den Nutzdaten.- Parameters:
data
- die Map mit den Nutzdaten.
-
setData
public void setData(java.lang.String key, java.io.Serializable data)
Speichert Nutzdaten zu dem angegebenen Schluessel.- Parameters:
key
- der Schluessel.data
- die Nutzdaten.
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
- See Also:
Object.toString()
-
-