Class Reminder

java.lang.Object
de.willuhn.jameica.reminder.Reminder
All Implemented Interfaces:
Serializable

public final class Reminder extends Object implements 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 Details

    • QUEUE_DEFAULT

      public static final String QUEUE_DEFAULT
      Name der Default-Queue, die verwendet wird, wenn keine angegeben wurde.
      See Also:
    • KEY_EXECUTED

      public static final String KEY_EXECUTED
      Key, in dem der Reminder-Service das Datum speichert, an dem der Reminder ausgefuehrt wurde.
      See Also:
    • KEY_EXPIRED

      public static final 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:
  • Constructor Details

    • Reminder

      public Reminder()
  • Method Details

    • getQueue

      public String getQueue()
      Liefert die Queue, an die die Message geschickt werden soll.
      Returns:
      die Queue.
    • setQueue

      public void setQueue(String queue)
      Speichert die Queue, an den die Message geschickt werden soll.
      Parameters:
      queue - die Queue.
    • getDate

      public Date getDate()
      Liefert den Termin, an dem die Message verschickt werden soll.
      Returns:
      Faelligkeitsdatum.
    • setDate

      public void setDate(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 Date getEnd()
      Liefert ein optionales Ende-Datum bei sich wiederholenden Remindern.
      Returns:
      optionales Ende-Datum.
    • setEnd

      public void setEnd(Date end)
      Speichert ein optionales Ende-Datum bei sich wiederholenden Remindern.
      Parameters:
      end - optionales Ende-Datum.
    • getData

      public Serializable getData(String key)
      Liefert die Nutzdaten zu dem angegebenen Schluessel.
      Parameters:
      key - der Schluessel.
      Returns:
      die Nutzdaten.
    • getData

      public Map<String,Serializable> getData()
      Liefert die Map mit den Nutzdaten.
      Returns:
      die Map mit den Nutzdaten.
    • setData

      public void setData(Map<String,Serializable> data)
      Speichert die Map mit den Nutzdaten.
      Parameters:
      data - die Map mit den Nutzdaten.
    • setData

      public void setData(String key, Serializable data)
      Speichert Nutzdaten zu dem angegebenen Schluessel.
      Parameters:
      key - der Schluessel.
      data - die Nutzdaten.
    • toString

      public String toString()
      Overrides:
      toString in class Object
      See Also: