com.aspose.email
Class RecurrenceRule

java.lang.Object
  extended by com.aspose.email.RecurrenceRule

public class RecurrenceRule
extends Object

Represents one recurrence or exception rule in a recurrence pattern.


 Corresponds to RRULE or EXRULE part in iCalendar.
 To construct a recurrence rule, you typically need to:
 1. Specify the type of the rule in Frequency.
 2. Specify how the recurrence pattern ends using EndType,
 Count or Until.
 3. Specify values in one or more ByXXX collections.
 Note, that if ByXXX rule part values are found which are beyond the available
 scope (ie, BYMONTHDAY=30 in February), they are simply ignored.

 Information, not contained in the rule, necessary to determine the various recurrence instance 
 start time and dates are derived from RecurrencePattern.StartDate. For example,
 "FREQ=YEARLY;BYMONTH=1" doesn't specify a specific day within the month or a time. This information 
 would be the same as what is specified for DTSTART.

 ByXXX rule parts modify the recurrence in some manner. ByXXX rule parts for a period of time which is 
 the same or greater than the frequency generally reduce or limit the number of occurrences of the
 recurrence generated. For example, "FREQ=DAILY;BYMONTH=1" reduces the number of recurrence instances 
 from all days (if BYMONTH tag is not present) to all days in January. ByXXX rule parts for a period of
 time less than the frequency generally increase or expand the number of occurrences of the recurrence. 
 For example, "FREQ=YEARLY;BYMONTH=1,2" increases the number of days within the yearly recurrence set 
 from 1 (if BYMONTH tag is not present) to 2.

 If multiple ByXXX rule parts are specified, then after evaluating the specified Frequency and Interval
 rule parts, the ByXXX rule parts are applied to the current set of evaluated occurrences in the following
 order: ByMonth, ByWeekNo, ByYearDay, ByMonthDay, 
 ByDay, ByHour, ByMinute, BySecond and 
 BySetPos; then Count and Until are evaluated.
 


Constructor Summary
RecurrenceRule()
           Initializes a new instance of the RecurrenceRule class.
 
Method Summary
 boolean equals(Object obj)
           
 boolean equals(RecurrenceRule other)
           
 ByDayCollection getByDay()
           Gets the by day.
 ByNumberCollection getByHour()
           Gets the by hour.
 ByNumberCollection getByMinute()
           Gets the by minute.
 ByNumberCollection getByMonth()
           Gets the by month.
 ByNumberCollection getByMonthDay()
           Gets the by month day.
 ByNumberCollection getBySecond()
           Gets the by second.
 ByNumberCollection getBySetPos()
           Gets the by set pos.
 ByNumberCollection getByWeekNo()
           Gets the by week no.
 ByNumberCollection getByYearDay()
           Gets the by year day.
 int getCount()
           Gets or sets the count.
 int getEndType()
           Gets or sets the end type.
 int getFrequency()
           Gets or sets the type of the recurrence rule.
 int getInterval()
           Gets or sets the interval.
 Date getUntil()
           
 int getWeekStart()
           Gets or sets the starting day of the week.
 int hashCode()
           
 void setCount(int value)
           
 void setEndType(int value)
           
 void setFrequency(int value)
           
 void setInterval(int value)
           
 void setUntil(Date value)
           
 void setWeekStart(int value)
           
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

RecurrenceRule

public RecurrenceRule()

Initializes a new instance of the RecurrenceRule class.

Method Detail

getWeekStart

public int getWeekStart()

Gets or sets the starting day of the week.


setWeekStart

public void setWeekStart(int value)

getFrequency

public int getFrequency()

Gets or sets the type of the recurrence rule.

Value: The frequency.


setFrequency

public void setFrequency(int value)

getInterval

public int getInterval()

Gets or sets the interval.

Value: The interval.


setInterval

public void setInterval(int value)

getEndType

public int getEndType()

Gets or sets the end type.

Value: The end type.


setEndType

public void setEndType(int value)

getCount

public int getCount()

Gets or sets the count.

Value: The count.


setCount

public void setCount(int value)

getUntil

public Date getUntil()

setUntil

public void setUntil(Date value)

getBySecond

public ByNumberCollection getBySecond()

Gets the by second.

Value: The by second.


getByMinute

public ByNumberCollection getByMinute()

Gets the by minute.

Value: The by minute.


getByHour

public ByNumberCollection getByHour()

Gets the by hour.

Value: The by hour.


getByMonth

public ByNumberCollection getByMonth()

Gets the by month.

Value: The by month.


getByDay

public ByDayCollection getByDay()

Gets the by day.

Value: The by day.


getBySetPos

public ByNumberCollection getBySetPos()

Gets the by set pos.

Value: The by set pos.


getByMonthDay

public ByNumberCollection getByMonthDay()

Gets the by month day.

Value: The by month day.


getByYearDay

public ByNumberCollection getByYearDay()

Gets the by year day.

Value: The by year day.


getByWeekNo

public ByNumberCollection getByWeekNo()

Gets the by week no.

Value: The by week no.


equals

public boolean equals(RecurrenceRule other)

equals

public boolean equals(Object obj)
Overrides:
equals in class Object

hashCode

public int hashCode()
Overrides:
hashCode in class Object


Copyright (c) 2008-2012 Aspose Pty Ltd. All Rights Reserved.