package caltool.model.schedule;

import mvp.*;

/****
 *
 * Class RecurringInfo has components to specify the nature of a recurring
 * item.  IsRecurring is an on/off flag that indicates whether an item recurs.
 * Interval is one of Weekly, Biweekly, Monthly, or Yearly.  The
 * IntervalDetails component defines the precise means to define recurrence for
 * the different interval levels.
 *
 */
public class RecurringInfo extends Model {

    /*-*
     * Derived data fields.
     */

    /** True if a scheduled item is recurring */
    boolean isRecurring;

    /** Specifies the granularity at which recurring items are defined */
    RecurringInterval interval;

    /** The details of recurrance, based on the value of interval.  If interval
        is weekly or biweekly, details points to an instance of WeeklyDetails.
        If interval is monthly, details points to an instance of
        MonthlyDeatils.  If interval is yearly, details is null. */
    IntervalDetails details;

}