Class Reminder

  • All Implemented Interfaces:
    com.infinitekind.tiksync.SyncableItem

    public class Reminder
    extends MoneydanceSyncableItem
    Reminder represents an item (usually a note or transaction) that can be scheduled to occur on a specific date or recurring series of dates.
    Author:
    Sean D. Reilly
    • Constructor Detail

    • Method Detail

      • itemWasUpdated

        protected void itemWasUpdated()
        Description copied from class: MoneydanceSyncableItem
        This is called after an item is updated by calling itemWasUpdated(SyncRecord). This can occur from the syncing process or from being loaded locally. Override this method to be notified.
        Overrides:
        itemWasUpdated in class MoneydanceSyncableItem
      • itemWillSync

        protected void itemWillSync()
        Description copied from class: MoneydanceSyncableItem
        This is called just before an item will be stored and/or synced when itemWillSync(SyncRecord) is called. Override this method to be notified or if you'd like to store anything into the info record to be synced.
        Overrides:
        itemWillSync in class MoneydanceSyncableItem
      • getSyncItemType

        public final java.lang.String getSyncItemType()
        Description copied from class: MoneydanceSyncableItem
        Subclasses should override this to return a static string identifying their type of object
        Specified by:
        getSyncItemType in interface com.infinitekind.tiksync.SyncableItem
        Overrides:
        getSyncItemType in class MoneydanceSyncableItem
      • setReminderType

        public void setReminderType​(Reminder.Type newReminderType)
      • getId

        public long getId()
      • setId

        public void setId​(long id)
      • getDescription

        public java.lang.String getDescription()
      • setDescription

        public void setDescription​(java.lang.String description)
      • getMemo

        public java.lang.String getMemo()
      • setMemo

        public void setMemo​(java.lang.String memo)
      • getInitialDateInt

        public int getInitialDateInt()
        Get the first date that the reminder will occur. The date should be an integer with decimal form YYYYMMDD.
      • setInitialDateInt

        public void setInitialDateInt​(int date)
        Set the first date that the reminder will occur. The date should be an integer with decimal form YYYYMMDD.
      • getLastDateInt

        public int getLastDateInt()
        Set a date after which this reminder should no longer occur. The date should be an integer with decimal form YYYYMMDD. If the value of the date is zero, then there is no last date.
      • setLastDateInt

        public void setLastDateInt​(int date)
        Set a date after which this reminder should no longer occur. The date should be an integer with decimal form YYYYMMDD If the value of the date is zero, then there is no last date.
      • getDateAcknowledgedInt

        public int getDateAcknowledgedInt()
        Get the last date that this reminder was acknowledged/accepted. The date should be an integer with decimal form YYYYMMDD
      • setAcknowledgedInt

        public void setAcknowledgedInt​(int date)
        Set the last date that this reminder was acknowledged/accepted. The date should be an integer with decimal form YYYYMMDD
      • getRepeatWeeklyModifier

        public int getRepeatWeeklyModifier()
      • getRepeatWeeklyDays

        public int[] getRepeatWeeklyDays()
      • setRepeatWeekly

        public void setRepeatWeekly​(int daysOfWeekModifier,
                                    int[] daysOfWeek)
      • getRepeatMonthlyModifier

        public int getRepeatMonthlyModifier()
      • getRepeatMonthly

        public int[] getRepeatMonthly()
      • setRepeatMonthly

        public void setRepeatMonthly​(int daysOfMonthModifier,
                                     int[] daysOfMonth)
      • getRepeatDaily

        public int getRepeatDaily()
      • setRepeatDaily

        public void setRepeatDaily​(int everyNDays)
      • getRepeatYearly

        public boolean getRepeatYearly()
      • setRepeatYearly

        public void setRepeatYearly​(boolean yearly)
      • getTransaction

        public ParentTxn getTransaction()
      • setTransaction

        public void setTransaction​(ParentTxn ptxn)
      • setRateAdjustmentOption

        public void setRateAdjustmentOption​(RateAdjustmentOption rateAdjustmentOption)
      • getAutoCommitDays

        public int getAutoCommitDays()
        Return the number of days prior to this transactions scheduled date that we should automatically add it to the transaction set. Returns -1 if the transaction should not auto-commit.
      • setAutoCommitDays

        public void setAutoCommitDays​(int autoCommitDays)
        Set the number of days prior to this transactions scheduled date that we should automatically add it to the transaction set. Set to -1 (or any negative number) if the transaction should not auto-commit.
      • isLoanReminder

        public boolean isLoanReminder()
      • setLoan

        public void setLoan​(boolean loan)
      • getPastDueDates

        public java.util.List<java.util.Date> getPastDueDates​(java.util.Calendar today)
        Return a Vector containing a list off Date objects for which this Reminder has been scheduled but not yet acknowledged.
      • hasBeenAcknowledged

        public boolean hasBeenAcknowledged​(java.util.Date asOfDate)
        Deprecated.
        use hasBeenAcknowledgedInt(int) instead
      • hasBeenAcknowledgedInt

        public boolean hasBeenAcknowledgedInt​(int asOfDate)
        Returns true if this reminder has been acknowledged as of the given date.
      • getNextOccurance

        public int getNextOccurance​(int maximumDate)
        Calculates the next date on which the reminder will occur (ie that is greater than the acknowledgement date) and that is equal to or below the given date. If there is no such date then this returns 0. Note: this can be an expensive operation
        Returns:
      • occursOnDate

        public boolean occursOnDate​(java.util.Calendar cal)
      • getTags

        public com.infinitekind.tiksync.SyncRecord getTags()
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object