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 TaskRecurrencePattern

com.moyosoft.exchange.task.TaskRecurrencePattern

public interface TaskRecurrencePattern

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

  • TaskRecurrenceType.RecursDaily:
    • getInterval
    setInterval    		Indicates the number of days between occurrences. The value 1 (one) means the task occurs every day.
  • TaskRecurrenceType.RecursWeekly:
    • getInterval
    setInterval    		Indicates the number of weeks between occurrences. The value 1 (one) means the task occurs every week.
    getDaysOfWeek
    setDaysOfWeek
    setDayOfWeek    		Indicates the days of week when the task occurs.
  • TaskRecurrenceType.RecursMonthly:
    • getInterval
    setInterval    		Indicates the number of months between occurrences. The value 1 (one) means the task occurs every month.
    getDayOfWeek
    setDayOfWeek    		Indicates the day of week when the task occurs.
  • TaskRecurrenceType.RecursMonthNth:
    • getInterval
    setInterval    		Indicates the number of months between occurrences. The value 1 (one) means the task occurs every month.
    getDayOfMonth
    setDayOfMonth    		Indicates the month's day on which the task occurs. Accepted values are in the range from 1 to 31.
  • TaskRecurrenceType.RecursYearly:
    • getDayOfWeek
    setDayOfWeek    		Indicates the day of week when the task occurs.
    getMonthOfYear
    setMonthOfYear    		Indicates the month during which the task occurs. Accepted values are in the range from 1 to 12.
  • TaskRecurrenceType.RecursYearNth:
    • getDayOfMonth
    setDayOfMonth    		Indicates the month's day on which the task occurs. Accepted values are in the range from 1 to 31.
    getMonthOfYear
    setMonthOfYear    		Indicates the month during which the task occurs. Accepted values are in the range from 1 to 12.
  • TaskRecurrenceType.RegenerateAfterDays:
    • getInterval
    setInterval    		Indicates how many days after the completion of the current task the next occurrence will be due.
  • TaskRecurrenceType.RegenerateAfterWeeks:
    • getInterval
    setInterval    		Indicates how many weeks after the completion of the current task the next occurrence will be due.
  • TaskRecurrenceType.RegenerateAfterMonths:
    • getInterval
    setInterval    		Indicates how many months after the completion of the current task the next occurrence will be due.
  • TaskRecurrenceType.RegenerateAfterYears:
    • getInterval
    setInterval    		Indicates how many years after the completion of the current task the next occurrence will be due.

Example code:

Exchange exchange = new Exchange("hostname", "username", "password");
ExchangeTask task = exchange.getTasksFolder().createTask();
RecurrencePattern recurrencePattern = task.getRecurrencePattern();

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

Methods

int
getDayOfMonth ()
Returns the month's day on which the task 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 task occurs. Only applicable if the RecurrenceType is RecursWeekly, RecursMonthly or RecursYearly.
int
getDayOfWeekIndex ()
Returns on which week in a month the task 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 task occurs. Only applicable if the RecurrenceType is RecursWeekly.
int
getInterval ()
Returns the interval between two occurrences in days, weeks or months depending on the type of recurrence.
int
getMonthOfYear ()
Returns the month during which the task 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 task indicating how many times the task recurs.
ExchangeTask
getParent ()
Returns the parent task of this recurrence pattern.
java.util.Date
getPatternEndDate ()
Returns the end date until which the task recurs.
java.util.Date
getPatternStartDate ()
Returns the start date on which the task starts recurring.
RecurrenceType
getRecurrenceType ()
Returns the type of this recurrence pattern.
TaskRecurrenceType
getTaskRecurrenceType ()
Returns the type of this recurrence pattern.
boolean
hasNoEndDate ()
Returns true if the task recurs indefinitely without an end date specified, false otherwise.
boolean
isEmpty ()
Returns true if no recurrence pattern is defined for the parent task item.
void
setDayOfMonth (int value)
Sets the month's day on which the task 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 task 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 task 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 task 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 task will recur indefinitely.
void
setInterval (int value)
Returns the interval between two occurrences of the recurring task.
void
setMonthOfYear (int value)
Sets the month during which the task 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 task.
void
setPatternEndDate (java.util.Date value)
Sets the end date until which the task recurs.
void
setPatternStartDate (java.util.Date value)
Sets the start date when the task starts recurring.
void
setRecurrenceType (RecurrenceType value)
Sets the type of this recurrence pattern.
void
setTaskRecurrenceType (TaskRecurrenceType value)
Sets the type of this recurrence pattern.

Community comments


Powered by JavaDocPlus