org.rapla.entities.domain
Interface Repeating


public interface Repeating

Encapsulates the repeating rule for an appointment.

See Also:
Appointment

Field Summary
static RepeatingType DAILY
           
static RepeatingType MONTHLY
           
static RepeatingType WEEKLY
           
static RepeatingType YEARLY
           
 
Method Summary
 void addException(Date date)
           
 void clearExceptions()
           
 Object clone()
           
 Appointment getAppointment()
          returns the appointment of this repeating.
 Date getEnd()
           
 Date[] getExceptions()
           
 int getInterval()
          returns the number of intervals between two repeatings.
 int getNumber()
           
 RepeatingType getType()
           
 boolean hasExceptions()
           
 boolean isDaily()
           
 boolean isException(long date)
           
 boolean isFixedNumber()
          The value returned depends which method was called last.
 boolean isMonthly()
           
 boolean isWeekly()
           
 boolean isYearly()
           
 void removeException(Date date)
           
 void setEnd(Date end)
          Set the end of repeating.
 void setInterval(int interval)
           
 void setNumber(int number)
          Set a fixed number of repeating.
 void setType(RepeatingType type)
           
 

Field Detail

DAILY

static final RepeatingType DAILY

WEEKLY

static final RepeatingType WEEKLY

MONTHLY

static final RepeatingType MONTHLY

YEARLY

static final RepeatingType YEARLY
Method Detail

setInterval

void setInterval(int interval)

getInterval

int getInterval()
returns the number of intervals between two repeatings. That are in the selected context:
  • For weekly repeatings: Number of weeks.
  • For dayly repeatings: Number of days.

  • isFixedNumber

    boolean isFixedNumber()
    The value returned depends which method was called last. If setNumber() has been called with a parameter >=0 fixedNumber() will return true. If setEnd() has been called fixedNumber() will return false.

    See Also:
    setEnd(java.util.Date), setNumber(int)

    setEnd

    void setEnd(Date end)
    Set the end of repeating. If this value is set to null and the number is set to -1 the appointment will repeat forever.

    Parameters:
    end - If not null isFixedNumber will return true.
    See Also:
    setNumber(int)

    getEnd

    Date getEnd()

    setNumber

    void setNumber(int number)
    Set a fixed number of repeating. If this value is set to -1 and the repeating end is set to null the appointment will repeat forever.

    Parameters:
    number - If >=0 isFixedNumber will return true.
    See Also:
    setEnd(java.util.Date), isFixedNumber()

    getNumber

    int getNumber()

    getType

    RepeatingType getType()

    setType

    void setType(RepeatingType type)

    getExceptions

    Date[] getExceptions()

    hasExceptions

    boolean hasExceptions()

    isWeekly

    boolean isWeekly()

    isDaily

    boolean isDaily()

    isMonthly

    boolean isMonthly()

    isYearly

    boolean isYearly()

    addException

    void addException(Date date)

    removeException

    void removeException(Date date)

    clearExceptions

    void clearExceptions()

    getAppointment

    Appointment getAppointment()
    returns the appointment of this repeating.

    See Also:
    Appointment

    isException

    boolean isException(long date)

    clone

    Object clone()


    Copyright © 2000-2006 Rapla Team. All Rights Reseserved.