Moyosoft Products | Services | Download | Contact us    
Java Bridge to Exchange
Products  >  Java Bridge to Exchange  >  API Reference    
API Reference
   
Overview  |  
All classes
Classic JavaDoc

Interface RecurrencePattern

com.moyosoft.exchange.calendar.RecurrencePattern

public interface RecurrencePattern

Represents a recurrence pattern of a calendar item. Based on the type of recurrence, the following methods are used to configure the recurrence:

  • RecurrenceType.RecursDaily:
    • getInterval
    setInterval    		Indicates the number of days between occurrences. The value 1 (one) means the appointment occurs every day.
  • RecurrenceType.RecursWeekly:
    • getInterval
    setInterval    		Indicates the number of weeks between occurrences. The value 1 (one) means the appointment occurs every week.
    getDaysOfWeek
    setDaysOfWeek
    setDayOfWeek    		Indicates the days of week when the appointment occurs.
  • RecurrenceType.RecursMonthly:
    • getInterval
    setInterval    		Indicates the number of months between occurrences. The value 1 (one) means the appointment occurs every month.
    getDayOfWeek
    setDayOfWeek    		Indicates the day of week when the appointment occurs.
  • RecurrenceType.RecursMonthNth:
    • getInterval
    setInterval    		Indicates the number of months between occurrences. The value 1 (one) means the appointment occurs every month.
    getDayOfMonth
    setDayOfMonth    		Indicates the month's day on which the appointment occurs. Accepted values are in the range from 1 to 31.
  • RecurrenceType.RecursYearly:
    • getDayOfWeek
    setDayOfWeek    		Indicates the day of week when the appointment occurs.
    getMonthOfYear
    setMonthOfYear    		Indicates the month during which the appointment occurs. Accepted values are in the range from 1 to 12.
  • RecurrenceType.RecursYearNth:
    • getDayOfMonth
    setDayOfMonth    		Indicates the month's day on which the appointment occurs. Accepted values are in the range from 1 to 31.
    getMonthOfYear
    setMonthOfYear    		Indicates the month during which the appointment occurs. Accepted values are in the range from 1 to 12.

Example code:

Exchange exchange = new Exchange("hostname", "username", "password");
ExchangeCalendarItem appointment = exchange.createCalendarItem();
RecurrencePattern recurrencePattern = appointment.getRecurrencePattern();

// Recurs 4 times every 2 months:
recurrencePattern.setRecurrenceType(RecurrenceType.RecursMonthly);
recurrencePattern.setInterval(2);
recurrencePattern.setOccurrences(4);
appointment.save();

Methods

int
getDayOfMonth ()
Returns the month's day on which the appointment occurs. Accepted values are in the range from 1 to 31. Only applicable if the RecurrenceType is RecursMonthNth or RecursYearNth.
DayOfWeek
getDayOfWeek ()
Returns the day of week when the appointment occurs. Only applicable if the RecurrenceType is RecursWeekly, RecursMonthly or RecursYearly.
int
getDayOfWeekIndex ()
Returns on which week in a month the appointment occurs. Possible values are -1 (last week), 1 (first week), 2 (second week), 3 (third week) and 4 (fourth week). Only applicable if the RecurrenceType is RecursMonthly or RecursYearly.
java.util.List
getDaysOfWeek ()
Returns the days of week when the appointment occurs. Only applicable if the RecurrenceType is RecursWeekly.
java.util.List
getDeletedOccurrences ()
Returns a list of the deleted occurrences of the recurring appointment.
ExchangeOccurrence
getFirstOccurrence ()
Returns the first occurrence of the recurring appointment.
int
getInterval ()
Returns the interval between two occurrences in days, weeks or months depending on the type of recurrence.
ExchangeOccurrence
getLastOccurrence ()
Returns the last occurrence of the recurring appointment.
java.util.List
getModifiedOccurrences ()
Returns a list of the modified occurrences of the recurring appointment.
int
getMonthOfYear ()
Returns the month during which the appointment occurs. Accepted values are in the range from 1 to 12. Only applicable if the RecurrenceType is RecursYearly or RecursYearNth.
int
getOccurrences ()
Returns the occurrences count of the recurring appointment indicating how many times the appointment recurs.
ExchangeCalendarItem
getParent ()
Returns the parent calendar item of this recurrence pattern.
java.util.Date
getPatternEndDate ()
Returns the end date until which the appointment recurs.
java.util.Date
getPatternStartDate ()
Returns the start date on which the appointment starts recurring.
RecurrenceType
getRecurrenceType ()
Returns the type of this recurrence pattern.
boolean
hasNoEndDate ()
Returns true if the appointment recurs indefinitely without an end date specified, false otherwise.
boolean
isEmpty ()
Returns true if no recurrence pattern is defined for the parent calendar item.
void
setDayOfMonth (int value)
Sets the month's day on which the appointment occurs. Accepted values are in the range from 1 to 31. Only applicable if the RecurrenceType is RecursMonthNth or RecursYearNth. If other RecurrenceType is set, this method will throw an exception.
void
setDayOfWeek (DayOfWeek value)
Sets the day of week when the appointment occurs. Only applicable if the RecurrenceType is RecursWeekly, RecursMonthly or RecursYearly. If other RecurrenceType is set, this method will throw an exception.
void
setDayOfWeekIndex (int index)
Sets the week in a month the appointment occurs on. Possible values are -1 (last week), 1 (first week), 2 (second week), 3 (third week) and 4 (fourth week). Only applicable if the RecurrenceType is RecursMonthly or RecursYearly.
void
setDaysOfWeek (DayOfWeek value)
Sets the days of week when the appointment occurs. Only applicable if the RecurrenceType is RecursWeekly. If other RecurrenceType is set, this method will throw an exception.
void
setHasNoEndDate (boolean value)
When set to true, the appointment will recur indefinitely.
void
setInterval (int value)
Returns the interval between two occurrences of the recurring appointment.
void
setMonthOfYear (int value)
Sets the month during which the appointment occurs. Accepted values are in the range from 1 to 12. Only applicable if the RecurrenceType is RecursYearly or RecursYearNth. If other RecurrenceType is set, this method will throw an exception.
void
setOccurrences (int value)
Sets the occurrences count of the recurring appointment.
void
setPatternEndDate (java.util.Date value)
Sets the end date until which the appointment recurs.
void
setPatternStartDate (java.util.Date value)
Sets the start date when the appointment starts recurring.
void
setRecurrenceType (RecurrenceType value)
Sets the type of this recurrence pattern.

Community comments


Powered by JavaDocPlus