|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.funambol.common.pim.model.common.Property
com.funambol.common.pim.model.common.PropertyWithTimeZone
com.funambol.common.pim.model.calendar.RecurrencePattern
public class RecurrencePattern
This class represents the recurrence pattern of a calendar item.
Field Summary | |
---|---|
static short |
ALL_DAYS_MASK
|
static byte |
DAY_OF_WEEK_FRIDAY
|
static byte |
DAY_OF_WEEK_MONDAY
|
static byte |
DAY_OF_WEEK_SATURDAY
|
static byte |
DAY_OF_WEEK_SUNDAY
|
static byte |
DAY_OF_WEEK_THURSDAY
|
static byte |
DAY_OF_WEEK_TUESDAY
|
static byte |
DAY_OF_WEEK_WEDNESDAY
|
static byte |
TYPE_DAILY
|
static byte |
TYPE_DAYLY
|
static byte |
TYPE_MONTH_NTH
|
static byte |
TYPE_MONTHLY
|
static byte |
TYPE_WEEKLY
|
static byte |
TYPE_YEAR_NTH
|
static byte |
TYPE_YEARLY
|
static short |
UNSPECIFIED
|
Fields inherited from class com.funambol.common.pim.model.common.PropertyWithTimeZone |
---|
timeZone |
Fields inherited from class com.funambol.common.pim.model.common.Property |
---|
altrep, chrset, cn, cutype, delegatedFrom, delegatedTo, dir, encoding, group, language, member, partstat, propertyValue, related, sentby, tag, type, value, xParams |
Constructor Summary | |
---|---|
RecurrencePattern(short type,
int interval,
short monthOfYear,
short dayOfMonth,
short dayOfWeekMask,
short instance,
java.lang.String startDatePattern,
java.lang.String endDatePattern,
boolean noEndDate)
Creates a new instance of RecurrencePattern. |
|
RecurrencePattern(short type,
int interval,
short monthOfYear,
short dayOfMonth,
short dayOfWeekMask,
short instance,
java.lang.String startDatePattern,
java.lang.String endDatePattern,
boolean noEndDate,
int occurrences)
Creates a new instance of RecurrencePattern. |
Method Summary | |
---|---|
boolean |
fix()
Fixes missing data on the basis of the startDatePattern field, according to the inference rules prescribed by the specifications (missing data must be inferred by the start date). |
static RecurrencePattern |
getDailyRecurrencePattern(int interval,
java.lang.String startDatePattern)
Infinite daily recurrence. |
static RecurrencePattern |
getDailyRecurrencePattern(int interval,
java.lang.String startDatePattern,
boolean noEndDate)
Infinite daily recurrence. |
static RecurrencePattern |
getDailyRecurrencePattern(int interval,
java.lang.String startDatePattern,
boolean noEndDate,
int occurrences)
Daily recurrence. |
static RecurrencePattern |
getDailyRecurrencePattern(int interval,
java.lang.String startDatePattern,
boolean noEndDate,
int occurrences,
short dayOfWeekMask)
Daily recurrence. |
static RecurrencePattern |
getDailyRecurrencePattern(int interval,
java.lang.String startDatePattern,
boolean noEndDate,
short dayOfWeekMask)
Infinite daily recurrence. |
static RecurrencePattern |
getDailyRecurrencePattern(int interval,
java.lang.String startDatePattern,
short dayOfWeekMask)
Inifinite daily recurrence. |
static RecurrencePattern |
getDailyRecurrencePattern(int interval,
java.lang.String startDatePattern,
java.lang.String endDatePattern)
Daily recurrence with start and end dates. |
static RecurrencePattern |
getDailyRecurrencePattern(int interval,
java.lang.String startDatePattern,
java.lang.String endDatePattern,
boolean noEndDate)
Daily recurrence with start, end dates and noEndDate. |
static RecurrencePattern |
getDailyRecurrencePattern(int interval,
java.lang.String startDatePattern,
java.lang.String endDatePattern,
boolean noEndDate,
int occurrences)
Daily recurrence |
static RecurrencePattern |
getDailyRecurrencePattern(int interval,
java.lang.String startDatePattern,
java.lang.String endDatePattern,
boolean noEndDate,
int occurrences,
short dayOfWeekMask)
Daily recurrence. |
static RecurrencePattern |
getDailyRecurrencePattern(int interval,
java.lang.String startDatePattern,
java.lang.String endDatePattern,
boolean noEndDate,
short dayOfWeekMask)
Daily recurrence with start, end dates and noEndDate. |
static RecurrencePattern |
getDailyRecurrencePattern(int interval,
java.lang.String startDatePattern,
java.lang.String endDatePattern,
short dayOfWeekMask)
Daily recurrence with start and end dates. |
short |
getDayOfMonth()
Returns the day of the month. |
java.util.List<java.lang.String> |
getDayOfWeek()
Return a list of abbreviations of days of week in which the task or event recurs. |
short |
getDayOfWeekMask()
Returns the day-of-week mask. |
java.lang.String |
getEndDatePattern()
Returns the end date pattern. |
java.util.List<ExceptionToRecurrenceRule> |
getExceptions()
Gets the exception list, duplicate-free and ordered. |
short |
getInstance()
Returns the instance number. |
int |
getInterval()
Returns the interval. |
static RecurrencePattern |
getMonthlyRecurrencePattern(int interval,
short dayOfMonth,
java.lang.String startDatePattern)
Infinite monthly recurrence. |
static RecurrencePattern |
getMonthlyRecurrencePattern(int interval,
short dayOfMonth,
java.lang.String startDatePattern,
boolean noEndDate)
Infinite monthly recurrence. |
static RecurrencePattern |
getMonthlyRecurrencePattern(int interval,
short dayOfMonth,
java.lang.String startDatePattern,
boolean noEndDate,
int occurrences)
Monthly recurrence. |
static RecurrencePattern |
getMonthlyRecurrencePattern(int interval,
short dayOfMonth,
java.lang.String startDatePattern,
java.lang.String endDatePattern)
Monthly recurrence with start and end dates. |
static RecurrencePattern |
getMonthlyRecurrencePattern(int interval,
short dayOfMonth,
java.lang.String startDatePattern,
java.lang.String endDatePattern,
boolean noEndDate)
Monthly recurrence with start, end dates and noEndDate. |
static RecurrencePattern |
getMonthlyRecurrencePattern(int interval,
short dayOfMonth,
java.lang.String startDatePattern,
java.lang.String endDatePattern,
boolean noEndDate,
int occurrences)
Monthly recurrence. |
static RecurrencePattern |
getMonthNthRecurrencePattern(int interval,
short dayOfWeekMask,
short instance,
java.lang.String startDatePattern)
Monthly day-of-week-based recurrence with start and end dates. |
static RecurrencePattern |
getMonthNthRecurrencePattern(int interval,
short dayOfWeekMask,
short instance,
java.lang.String startDatePattern,
boolean noEndDate)
Monthly day-of-week-based recurrence with start and end dates. |
static RecurrencePattern |
getMonthNthRecurrencePattern(int interval,
short dayOfWeekMask,
short instance,
java.lang.String startDatePattern,
java.lang.String endDatePattern)
Monthly day-of-week-based recurrence with start and end dates. |
static RecurrencePattern |
getMonthNthRecurrencePattern(int interval,
short dayOfWeekMask,
short instance,
java.lang.String startDatePattern,
java.lang.String endDatePattern,
boolean noEndDate,
int occurrences)
Monthly day-of-week-based recurrence with start, end dates and noEndDate. |
short |
getMonthOfYear()
Returns the month of year. |
int |
getOccurrences()
Returns the number of occurrences. |
java.lang.String |
getStartDatePattern()
Returns the start date pattern. |
java.lang.String |
getTypeDesc()
Gives a vCalendar short form for the recurrence frequency. |
short |
getTypeId()
Returns the recurrence frequency as a number. |
static RecurrencePattern |
getWeeklyRecurrencePattern(int interval,
short dayOfWeekMask,
java.lang.String startDatePattern)
Infinite weekly recurrence |
static RecurrencePattern |
getWeeklyRecurrencePattern(int interval,
short dayOfWeekMask,
java.lang.String startDatePattern,
boolean noEndDate)
Infinite weekly recurrence |
static RecurrencePattern |
getWeeklyRecurrencePattern(int interval,
short dayOfWeekMask,
java.lang.String startDatePattern,
java.lang.String endDatePattern)
Weekly recurrence with start and end dates. |
static RecurrencePattern |
getWeeklyRecurrencePattern(int interval,
short dayOfWeekMask,
java.lang.String startDatePattern,
java.lang.String endDatePattern,
boolean noEndDate)
Weekly recurrence with start, end dates and noEndDate. |
static RecurrencePattern |
getWeeklyRecurrencePattern(int interval,
short dayOfWeekMask,
java.lang.String startDatePattern,
java.lang.String endDatePattern,
boolean noEndDate,
int occurrences)
Weekly recurrence. |
static RecurrencePattern |
getYearlyRecurrencePattern(int interval,
short dayOfMonth,
short monthOfYear,
java.lang.String startDatePattern)
Infinite yearly recurrence. |
static RecurrencePattern |
getYearlyRecurrencePattern(int interval,
short dayOfMonth,
short monthOfYear,
java.lang.String startDatePattern,
boolean noEndDate)
Infinite yearly recurrence. |
static RecurrencePattern |
getYearlyRecurrencePattern(int interval,
short dayOfMonth,
short monthOfYear,
java.lang.String startDatePattern,
java.lang.String endDatePattern)
Yearly recurrence with start, end dates and noEndDate |
static RecurrencePattern |
getYearlyRecurrencePattern(int interval,
short dayOfMonth,
short monthOfYear,
java.lang.String startDatePattern,
java.lang.String endDatePattern,
boolean noEndDate)
Yearly recurrence with start, end dates and noEndDate. |
static RecurrencePattern |
getYearlyRecurrencePattern(int interval,
short dayOfMonth,
short monthOfYear,
java.lang.String startDatePattern,
java.lang.String endDatePattern,
boolean noEndDate,
int occurrences)
Yearly recurrence. |
static RecurrencePattern |
getYearNthRecurrencePattern(int interval,
short dayOfWeekMask,
short monthOfYear,
short instance,
java.lang.String startDatePattern)
Yearly day-of-week-based recurrence with start and end dates. |
static RecurrencePattern |
getYearNthRecurrencePattern(int interval,
short dayOfWeekMask,
short monthOfYear,
short instance,
java.lang.String startDatePattern,
boolean noEndDate)
Yearly day-of-week-based recurrence with start and end dates. |
static RecurrencePattern |
getYearNthRecurrencePattern(int interval,
short dayOfWeekMask,
short monthOfYear,
short instance,
java.lang.String startDatePattern,
java.lang.String endDatePattern)
Yearly day-of-week-based recurrence with start and end dates. |
static RecurrencePattern |
getYearNthRecurrencePattern(int interval,
short dayOfWeekMask,
short monthOfYear,
short instance,
java.lang.String startDatePattern,
java.lang.String endDatePattern,
boolean noEndDate)
Yearly day-of-week-based recurrence with start, end dates and noEndDate. |
static RecurrencePattern |
getYearNthRecurrencePattern(int interval,
short dayOfWeekMask,
short monthOfYear,
short instance,
java.lang.String startDatePattern,
java.lang.String endDatePattern,
boolean noEndDate,
int occurrences)
Yearly day-of-week-based recurrence. |
boolean |
isNoEndDate()
Returns whether the pattern has no end date set. |
void |
setExceptions(java.util.List<ExceptionToRecurrenceRule> exceptions)
Sets the exception list. |
void |
setExceptions(java.util.SortedSet<ExceptionToRecurrenceRule> exceptions)
Sets the exception set. |
void |
setNoEndDate(boolean noEndDate)
Setter for property noEndDate. |
void |
setOccurrences(int occurrences)
Setter for property occurrences. |
java.lang.String |
toString()
|
Methods inherited from class com.funambol.common.pim.model.common.PropertyWithTimeZone |
---|
getTimeZone, setTimeZone |
Methods inherited from class com.funambol.common.pim.model.common.Property |
---|
compare, equals, getAltrep, getCharset, getCn, getCutype, getDelegatedFrom, getDelegatedTo, getDir, getEncoding, getGroup, getLanguage, getMember, getPartstat, getPropertyValue, getPropertyValueAsString, getRelated, getSentby, getTag, getType, getValue, getXParams, hashCode, isEmptyProperty, setAltrep, setCharset, setCn, setCutype, setDelegatedFrom, setDelegatedTo, setDir, setEncoding, setGroup, setLanguage, setMember, setPartstat, setPropertyValue, setRelated, setSentby, setTag, setType, setValue, setXParams, stringFrom, stringFrom |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final byte TYPE_DAYLY
public static final byte TYPE_DAILY
public static final byte TYPE_WEEKLY
public static final byte TYPE_MONTHLY
public static final byte TYPE_MONTH_NTH
public static final byte TYPE_YEARLY
public static final byte TYPE_YEAR_NTH
public static final byte DAY_OF_WEEK_SUNDAY
public static final byte DAY_OF_WEEK_MONDAY
public static final byte DAY_OF_WEEK_TUESDAY
public static final byte DAY_OF_WEEK_WEDNESDAY
public static final byte DAY_OF_WEEK_THURSDAY
public static final byte DAY_OF_WEEK_FRIDAY
public static final byte DAY_OF_WEEK_SATURDAY
public static final short ALL_DAYS_MASK
public static final short UNSPECIFIED
Constructor Detail |
---|
public RecurrencePattern(short type, int interval, short monthOfYear, short dayOfMonth, short dayOfWeekMask, short instance, java.lang.String startDatePattern, java.lang.String endDatePattern, boolean noEndDate)
frequency
- interval
- monthOfYear
- dayOfMonth
- dayOfWeekMask
- instance
- startDatePattern
- endDatePattern
- noEndDate
- public RecurrencePattern(short type, int interval, short monthOfYear, short dayOfMonth, short dayOfWeekMask, short instance, java.lang.String startDatePattern, java.lang.String endDatePattern, boolean noEndDate, int occurrences)
frequency
- interval
- monthOfYear
- dayOfMonth
- dayOfWeekMask
- instance
- startDatePattern
- endDatePattern
- noEndDate
- occurrences
- Method Detail |
---|
public short getTypeId()
public int getInterval()
public short getMonthOfYear()
public short getDayOfWeekMask()
public short getDayOfMonth()
public short getInstance()
public java.lang.String getStartDatePattern()
public boolean isNoEndDate()
public void setNoEndDate(boolean noEndDate)
noEndDate
- new value of property noEndDatepublic java.lang.String getEndDatePattern()
public int getOccurrences()
public void setOccurrences(int occurrences)
occurrences
- new value of property occurrencespublic static RecurrencePattern getDailyRecurrencePattern(int interval, java.lang.String startDatePattern, java.lang.String endDatePattern) throws RecurrencePatternException
interval
- how many days between two recurrencesstartDatePattern
- start date patternendDatePattern
- end date pattern
RecurrencePatternException
- in case of wrong parameterspublic static RecurrencePattern getDailyRecurrencePattern(int interval, java.lang.String startDatePattern, java.lang.String endDatePattern, short dayOfWeekMask) throws RecurrencePatternException
interval
- how many days between two recurrencesstartDatePattern
- start date patternendDatePattern
- end date patterndayOfWeekMask
- days when the event or task occurs
RecurrencePatternException
- in case of wrong parameterspublic static RecurrencePattern getDailyRecurrencePattern(int interval, java.lang.String startDatePattern, java.lang.String endDatePattern, boolean noEndDate) throws RecurrencePatternException
interval
- how many days between two recurrencesstartDatePattern
- start date patternendDatePattern
- end date patternnoEndDate
- is the pattern without end date?
RecurrencePatternException
- in case of wrong parameterspublic static RecurrencePattern getDailyRecurrencePattern(int interval, java.lang.String startDatePattern, java.lang.String endDatePattern, boolean noEndDate, short dayOfWeekMask) throws RecurrencePatternException
interval
- how many days between two recurrencesstartDatePattern
- start date patternendDatePattern
- end date patternnoEndDate
- is the recurrence without end date?dayOfWeekMask
- days when the event or task occurs
RecurrencePatternException
- in case of wrong parameterspublic static RecurrencePattern getDailyRecurrencePattern(int interval, java.lang.String startDatePattern, java.lang.String endDatePattern, boolean noEndDate, int occurrences) throws RecurrencePatternException
interval
- how many days between two recurrencesstartDatePattern
- start date patternendDatePattern
- end date patternnoEndDate
- is the recurrence without end date?occurrences
- number of occurrences
RecurrencePatternException
- in case of wrong parameterspublic static RecurrencePattern getDailyRecurrencePattern(int interval, java.lang.String startDatePattern, java.lang.String endDatePattern, boolean noEndDate, int occurrences, short dayOfWeekMask) throws RecurrencePatternException
interval
- how many days between two recurrencestartDatePattern
- start date patternendDatePattern
- end date patternnoEndDate
- is the recurrence without end date?occurrences
- number of occurrencesdayOfWeekMask
- days when the event or task occurs
RecurrencePatternException
- in case of wrong parameterspublic static RecurrencePattern getDailyRecurrencePattern(int interval, java.lang.String startDatePattern) throws RecurrencePatternException
interval
- how many days between two recurrencesstartDatePattern
- start date pattern
RecurrencePatternException
- in case of wrong parameterspublic static RecurrencePattern getDailyRecurrencePattern(int interval, java.lang.String startDatePattern, short dayOfWeekMask) throws RecurrencePatternException
interval
- how many days between two recurrencesstartDatePattern
- start date patterndayOfWeekMask
- days when the event or task occurs
RecurrencePatternException
- in case of wrong parameterspublic static RecurrencePattern getDailyRecurrencePattern(int interval, java.lang.String startDatePattern, boolean noEndDate) throws RecurrencePatternException
interval
- how many days between two recurrencesstartDatePattern
- start date patternnoEndDate
- is the recurrence without end date?
RecurrencePatternException
- in case of wrong parameterspublic static RecurrencePattern getDailyRecurrencePattern(int interval, java.lang.String startDatePattern, boolean noEndDate, short dayOfWeekMask) throws RecurrencePatternException
interval
- how many days between two recurrencesstartDatePattern
- start date patternnoEndDate
- is the recurrence without end date?dayOfWeekMask
- days when the event or task occurs
RecurrencePatternException
- in case of wrong parameterspublic static RecurrencePattern getDailyRecurrencePattern(int interval, java.lang.String startDatePattern, boolean noEndDate, int occurrences) throws RecurrencePatternException
interval
- how many days between two recurrencesstartDatePattern
- start date patternnoEndDate
- is the recurrence without end date?occurrences
- number of occurrences
RecurrencePatternException
- in case of wrong parameterspublic static RecurrencePattern getDailyRecurrencePattern(int interval, java.lang.String startDatePattern, boolean noEndDate, int occurrences, short dayOfWeekMask) throws RecurrencePatternException
interval
- how many days between two recurrencesstartDatePattern
- start date patternnoEndDate
- is the recurrence without end date?occurrences
- number of occurrencesdayOfWeekMask
- days when the event or task occurs
RecurrencePatternException
- in case of wrong parameterspublic static RecurrencePattern getWeeklyRecurrencePattern(int interval, short dayOfWeekMask, java.lang.String startDatePattern, java.lang.String endDatePattern) throws RecurrencePatternException
interval
- how many weeks between two recurrencesdayOfWeekMask
- days when the event or task occursstartDatePattern
- start date patternendDatePattern
- end date pattern
RecurrencePatternException
- in case of wrong parameterspublic static RecurrencePattern getWeeklyRecurrencePattern(int interval, short dayOfWeekMask, java.lang.String startDatePattern, java.lang.String endDatePattern, boolean noEndDate) throws RecurrencePatternException
interval
- how many weeks between two recurrencesdayOfWeekMask
- days when the event or task occursstartDatePattern
- start date patternendDatePattern
- end date patternnoEndDate
- is the recurrence without end date?
RecurrencePatternException
- in case of wrong parameterspublic static RecurrencePattern getWeeklyRecurrencePattern(int interval, short dayOfWeekMask, java.lang.String startDatePattern, java.lang.String endDatePattern, boolean noEndDate, int occurrences) throws RecurrencePatternException
interval
- how many weeks between two recurrencesdayOfWeekMask
- days when the event or task occursstartDatePattern
- start date patternendDatePattern
- end date patternnoEndDate
- is the recurrence without end date?occurrences
- number of occurrences
RecurrencePatternException
- in case of wrong parameterspublic static RecurrencePattern getWeeklyRecurrencePattern(int interval, short dayOfWeekMask, java.lang.String startDatePattern) throws RecurrencePatternException
interval
- how many days between two recurrencesdayOfWeekMask
- days when the event or task occursstartDatePattern
- start date pattern
RecurrencePatternException
- in case of wrong parameterspublic static RecurrencePattern getWeeklyRecurrencePattern(int interval, short dayOfWeekMask, java.lang.String startDatePattern, boolean noEndDate) throws RecurrencePatternException
interval
- how many days between two recurrencesdayOfWeekMask
- days when the event or task occursstartDatePattern
- start date patternnoEndDate
- is the recurrence without end date?
RecurrencePatternException
- in case of wrong parameterspublic static RecurrencePattern getMonthlyRecurrencePattern(int interval, short dayOfMonth, java.lang.String startDatePattern, java.lang.String endDatePattern) throws RecurrencePatternException
interval
- how many months between two recurrencesdayOfMonth
- day of month (1-31) when the event or task occursstartDatePattern
- start date patternendDatePattern
- end date pattern
RecurrencePatternException
- in case of wrong parameterspublic static RecurrencePattern getMonthlyRecurrencePattern(int interval, short dayOfMonth, java.lang.String startDatePattern, java.lang.String endDatePattern, boolean noEndDate, int occurrences) throws RecurrencePatternException
interval
- how many months between two recurrencesdayOfMonth
- day of month (1-31) when the event or task occursstartDatePattern
- start date patternendDatePattern
- end date patternnoEndDate
- is the recurrence without end date?occurrences
- number of occurrences
RecurrencePatternException
- in case of wrong parameterspublic static RecurrencePattern getMonthlyRecurrencePattern(int interval, short dayOfMonth, java.lang.String startDatePattern, java.lang.String endDatePattern, boolean noEndDate) throws RecurrencePatternException
interval
- how many months between two recurrencesdayOfMonth
- day of month (1-31) when the event or task occursstartDatePattern
- start date patternendDatePattern
- end date patternnoEndDate
- is the recurrence without end date?
RecurrencePatternException
- in case of wrong parameterspublic static RecurrencePattern getMonthlyRecurrencePattern(int interval, short dayOfMonth, java.lang.String startDatePattern) throws RecurrencePatternException
interval
- how many days between two recurrencesdayOfMonth
- day of month (1-31) when the event or task occursstartDatePattern
- start date pattern
RecurrencePatternException
- in case of wrong parameterspublic static RecurrencePattern getMonthlyRecurrencePattern(int interval, short dayOfMonth, java.lang.String startDatePattern, boolean noEndDate, int occurrences) throws RecurrencePatternException
interval
- how many days between two recurrencesdayOfMonth
- day of month (1-31) when the event or task occursstartDatePattern
- start date patternnoEndDate
- is the recurrence without end date?occurrences
- number of occurrences
RecurrencePatternException
- in case of wrong parameterspublic static RecurrencePattern getMonthlyRecurrencePattern(int interval, short dayOfMonth, java.lang.String startDatePattern, boolean noEndDate) throws RecurrencePatternException
interval
- how many days between two recurrencesdayOfMonth
- day of month (1-31) when the event or task occursstartDatePattern
- start date patternnoEndDate
- is the recurrence without end date?
RecurrencePatternException
- in case of wrong parameterspublic static RecurrencePattern getMonthNthRecurrencePattern(int interval, short dayOfWeekMask, short instance, java.lang.String startDatePattern, java.lang.String endDatePattern) throws RecurrencePatternException
interval
- how many months between two recurrencesdayOfWeekMask
- see belowinstance
- the instance of dayOfWeekMask of every
interval monthsstartDatePattern
- start date patternendDatePattern
- end date pattern
RecurrencePatternException
- in case of wront parameterspublic static RecurrencePattern getMonthNthRecurrencePattern(int interval, short dayOfWeekMask, short instance, java.lang.String startDatePattern, java.lang.String endDatePattern, boolean noEndDate, int occurrences) throws RecurrencePatternException
interval
- how many months between two recurrencesdayOfWeekMask
- see belowinstance
- the instance of dayOfWeekMask of every
interval monthsstartDatePattern
- start date patternendDatePattern
- end date patternnoEndDate
- is the recurrence without end date?occurrences
- number of occurrences
RecurrencePatternException
- in case of wrong parameterspublic static RecurrencePattern getMonthNthRecurrencePattern(int interval, short dayOfWeekMask, short instance, java.lang.String startDatePattern) throws RecurrencePatternException
interval
- how many months between two recurrencesdayOfWeekMask
- see belowinstance
- the instance of dayOfWeekMask of every interval monthsstartDatePattern
- start date pattern
RecurrencePatternException
- in case of wrong parameterspublic static RecurrencePattern getMonthNthRecurrencePattern(int interval, short dayOfWeekMask, short instance, java.lang.String startDatePattern, boolean noEndDate) throws RecurrencePatternException
interval
- how many months between two recurrencesdayOfWeekMask
- see belowinstance
- the instance of dayOfWeekMask of every interval monthsstartDatePattern
- start date patternnoEndDate
- is the recurrence without end date?
RecurrencePatternException
- in case of wrong parameterspublic static RecurrencePattern getYearlyRecurrencePattern(int interval, short dayOfMonth, short monthOfYear, java.lang.String startDatePattern, java.lang.String endDatePattern, boolean noEndDate) throws RecurrencePatternException
interval
- how many years between two recurrencesdayOfMonth
- day of month (1-31) when the event or task occursmonthOfYear
- month (1-12) of the year when the event or task occursstartDatePattern
- start date patternendDatePattern
- end date patternnoEndDate
- is the recurrence without end date?
RecurrencePatternException
- in case of wrong parameterspublic static RecurrencePattern getYearlyRecurrencePattern(int interval, short dayOfMonth, short monthOfYear, java.lang.String startDatePattern, java.lang.String endDatePattern, boolean noEndDate, int occurrences) throws RecurrencePatternException
interval
- how many years between two recurrencesdayOfMonth
- day of month (1-31) when the event or task occursmonthOfYear
- month (1-12) of the year when the event or task occursstartDatePattern
- start date patternendDatePattern
- end date patternnoEndDate
- is the recurrence without end date?occurrences
- number of occurrences
RecurrencePatternException
- in case of wrong parameterspublic static RecurrencePattern getYearlyRecurrencePattern(int interval, short dayOfMonth, short monthOfYear, java.lang.String startDatePattern, java.lang.String endDatePattern) throws RecurrencePatternException
interval
- how many years between two recurrencesdayOfMonth
- day of month (1-31) when the event or task occursmonthOfYear
- month (1-12) of the year when the event or task occursstartDatePattern
- start date patternendDatePattern
- end date pattern
RecurrencePatternException
- in case of wrong parameterspublic static RecurrencePattern getYearlyRecurrencePattern(int interval, short dayOfMonth, short monthOfYear, java.lang.String startDatePattern) throws RecurrencePatternException
interval
- how many years between two recurrencesdayOfMonth
- day of month (1-31) when the event or task occursmonthOfYear
- month (1-12) of the year when the event or task occursstartDatePattern
- start date pattern
RecurrencePatternException
- in case of wrong parameterspublic static RecurrencePattern getYearlyRecurrencePattern(int interval, short dayOfMonth, short monthOfYear, java.lang.String startDatePattern, boolean noEndDate) throws RecurrencePatternException
interval
- how many years between two recurrencesdayOfMonth
- day of month (1-31) when the event or task occursmonthOfYear
- month (1-12) of the year when the event or task occursstartDatePattern
- start date patternnoEndDate
- is the recurrence without end date?
RecurrencePatternException
- in case of wrong parameterspublic static RecurrencePattern getYearNthRecurrencePattern(int interval, short dayOfWeekMask, short monthOfYear, short instance, java.lang.String startDatePattern, java.lang.String endDatePattern, boolean noEndDate) throws RecurrencePatternException
interval
- how many years between two recurrencesdayOfWeekMask
- days when the event or task occursmonthOfYear
- month (1-12) of the year when the event or task occursinstance
- every instance of dayOfWeekMask of
monthOfYearstartDatePattern
- start date patternendDatePattern
- end date patternnoEndDate
- is the recurrence without end date?
RecurrencePatternException
- in case of wrong parameterspublic static RecurrencePattern getYearNthRecurrencePattern(int interval, short dayOfWeekMask, short monthOfYear, short instance, java.lang.String startDatePattern, java.lang.String endDatePattern, boolean noEndDate, int occurrences) throws RecurrencePatternException
interval
- how many years between two recurrencesdayOfWeekMask
- days when the event or task occursmonthOfYear
- month (1-12) of the year when the event or task occursinstance
- every instance of dayOfWeekMask of
monthOfYearstartDatePattern
- start date patternendDatePattern
- end date patternnoEndDate
- is the recurrence without end date?occurrences
- number of occurrences
RecurrencePatternException
- in case of wrong parameterspublic static RecurrencePattern getYearNthRecurrencePattern(int interval, short dayOfWeekMask, short monthOfYear, short instance, java.lang.String startDatePattern, java.lang.String endDatePattern) throws RecurrencePatternException
interval
- how many years between two recurrencesdayOfWeekMask
- days when the event or task occursmonthOfYear
- month (1-12) of the year when the event or task occursinstance
- every instance of dayOfWeekMask of
monthOfYearstartDatePattern
- start date patternendDatePattern
- end date pattern
RecurrencePatternException
- in case of wrong parameterspublic static RecurrencePattern getYearNthRecurrencePattern(int interval, short dayOfWeekMask, short monthOfYear, short instance, java.lang.String startDatePattern) throws RecurrencePatternException
interval
- how many years between two recurrencesdayOfWeekMask
- days when the event or task occursmonthOfYear
- month (1-12) of the year when the event or task occursinstance
- every instance of dayOfWeekMask of
monthOfYearstartDatePattern
- start date pattern
RecurrencePatternException
- in case of wrong parameterspublic static RecurrencePattern getYearNthRecurrencePattern(int interval, short dayOfWeekMask, short monthOfYear, short instance, java.lang.String startDatePattern, boolean noEndDate) throws RecurrencePatternException
interval
- how many years between two recurrencesdayOfWeekMask
- days when the event or task occursmonthOfYear
- month (1-12) of the year when the event or task occursinstance
- every instance of dayOfWeekMask of
monthOfYearstartDatePattern
- start date patternnoEndDate
- is the recurrence without end date?
RecurrencePatternException
- in case of wrong parameterspublic java.lang.String getTypeDesc()
public java.util.List<java.lang.String> getDayOfWeek()
public java.lang.String toString()
toString
in class java.lang.Object
public java.util.List<ExceptionToRecurrenceRule> getExceptions()
public void setExceptions(java.util.List<ExceptionToRecurrenceRule> exceptions)
exceptions
- the exceptions as a List collectionpublic void setExceptions(java.util.SortedSet<ExceptionToRecurrenceRule> exceptions)
exceptions
- the exceptions as a SortedSet collectionpublic boolean fix() throws RecurrencePatternException
RecurrencePatternException
- if no automatic fix was possible
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |