RecurringTaskInfo
Inheritance: java.lang.Object
public class RecurringTaskInfo
Represents the details of a recurring task in a project.
Methods
| Method | Description |
|---|---|
| getDailyRepetitions() | Gets a number of repetitions for the daily recurrence pattern. |
| getDailyUseWorkdays() | Gets a value indicating whether to use workdays for the daily recurrence pattern. |
| getDuration() | Gets the duration for one occurrence of the recurring task. |
| getEndDate() | Gets the date for the occurrences to end. |
| getMonthlyDay() | Gets a number of day of the monthly recurrence pattern. |
| getMonthlyOrdinalDay() | Gets a day of the monthly recurrence pattern when using ordinal day. |
| getMonthlyOrdinalNumber() | Gets an ordinal number of the monthly recurrence pattern. |
| getMonthlyOrdinalRepetitions() | Gets a number of repetitions for the monthly recurrence pattern when using ordinal day. |
| getMonthlyRepetitions() | Gets a number of repetitions for the monthly recurrence pattern. |
| getMonthlyUseOrdinalDay() | Gets a value indicating whether to use ordinal day for the monthly recurrence pattern. |
| getOccurrences() | Gets a number of occurrences of the recurring task. |
| getRecurrencePattern() | Gets a recurrence pattern of the recurring task. |
| getStartDate() | Gets the date for the occurrences to begin. |
| getTask() | Gets the parent task of this instance of RecurringTaskInfo class. |
| getUseEndDate() | Gets a value indicating whether to use the end date or a number of occurrences for the recurring task. |
| getWeeklyDays() | Gets a collection of days used in the weekly recurrence pattern. |
| getWeeklyRepetitions() | Gets a number of repetitions for the weekly recurrence pattern. |
| getYearlyDate() | Gets a date for the yearly recurrence pattern. |
| getYearlyOrdinalDay() | Gets a weekday of the yearly recurrence pattern when using ordinal day. |
| getYearlyOrdinalMonth() | Gets a month of the yearly recurrence pattern when using ordinal day. |
| getYearlyOrdinalNumber() | Gets an ordinal number of the yearly recurrence pattern. |
| getYearlyUseOrdinalDay() | Gets a value indicating whether to use ordinal day for the yearly recurrence pattern. |
| setDailyRepetitions(int value) | Sets a number of repetitions for the daily recurrence pattern. |
| setDailyUseWorkdays(boolean value) | Sets a value indicating whether to use workdays for the daily recurrence pattern. |
| setDuration(Duration value) | Sets the duration for one occurrence of the recurring task. |
| setEndDate(Date value) | Sets the date for the occurrences to end. |
| setMonthlyDay(int value) | Sets a number of day of the monthly recurrence pattern. |
| setMonthlyOrdinalDay(int value) | Sets a day of the monthly recurrence pattern when using ordinal day. |
| setMonthlyOrdinalNumber(int value) | Sets an ordinal number of the monthly recurrence pattern. |
| setMonthlyOrdinalRepetitions(int value) | Sets a number of repetitions for the monthly recurrence pattern when using ordinal day. |
| setMonthlyRepetitions(int value) | Sets a number of repetitions for the monthly recurrence pattern. |
| setMonthlyUseOrdinalDay(boolean value) | Sets a value indicating whether to use ordinal day for the monthly recurrence pattern. |
| setOccurrences(int value) | Sets a number of occurrences of the recurring task. |
| setRecurrencePattern(int value) | Sets a recurrence pattern of the recurring task. |
| setStartDate(Date value) | Sets the date for the occurrences to begin. |
| setUseEndDate(boolean value) | Sets a value indicating whether to use the end date or a number of occurrences for the recurring task. |
| setWeeklyDays(int value) | Sets a collection of days used in the weekly recurrence pattern. |
| setWeeklyRepetitions(int value) | Sets a number of repetitions for the weekly recurrence pattern. |
| setYearlyDate(Date value) | Sets a date for the yearly recurrence pattern. |
| setYearlyOrdinalDay(int value) | Sets a weekday of the yearly recurrence pattern when using ordinal day. |
| setYearlyOrdinalMonth(int value) | Sets a month of the yearly recurrence pattern when using ordinal day. |
| setYearlyOrdinalNumber(int value) | Sets an ordinal number of the yearly recurrence pattern. |
| setYearlyUseOrdinalDay(boolean value) | Sets a value indicating whether to use ordinal day for the yearly recurrence pattern. |
getDailyRepetitions()
public final int getDailyRepetitions()
Gets a number of repetitions for the daily recurrence pattern.
Returns: int - a number of repetitions for the daily recurrence pattern.
getDailyUseWorkdays()
public final boolean getDailyUseWorkdays()
Gets a value indicating whether to use workdays for the daily recurrence pattern.
Returns: boolean - a value indicating whether to use workdays for the daily recurrence pattern.
getDuration()
public final Duration getDuration()
Gets the duration for one occurrence of the recurring task.
the instance of Duration(getDuration()/setDuration(Duration)) class.
Returns: Duration - the duration for one occurrence of the recurring task.
getEndDate()
public final Date getEndDate()
Gets the date for the occurrences to end.
Returns: java.util.Date - the date for the occurrences to end.
getMonthlyDay()
public final int getMonthlyDay()
Gets a number of day of the monthly recurrence pattern.
Returns: int - a number of day of the monthly recurrence pattern.
getMonthlyOrdinalDay()
public final int getMonthlyOrdinalDay()
Gets a day of the monthly recurrence pattern when using ordinal day.
Can be one of the values of DayOfWeek enumeration.
Returns: int - a day of the monthly recurrence pattern when using ordinal day.
getMonthlyOrdinalNumber()
public final int getMonthlyOrdinalNumber()
Gets an ordinal number of the monthly recurrence pattern.
Can be one of the values of OrdinalNumber enumeration.
Returns: int - an ordinal number of the monthly recurrence pattern.
getMonthlyOrdinalRepetitions()
public final int getMonthlyOrdinalRepetitions()
Gets a number of repetitions for the monthly recurrence pattern when using ordinal day.
Returns: int - a number of repetitions for the monthly recurrence pattern when using ordinal day.
getMonthlyRepetitions()
public final int getMonthlyRepetitions()
Gets a number of repetitions for the monthly recurrence pattern.
Returns: int - a number of repetitions for the monthly recurrence pattern.
getMonthlyUseOrdinalDay()
public final boolean getMonthlyUseOrdinalDay()
Gets a value indicating whether to use ordinal day for the monthly recurrence pattern.
Returns: boolean - a value indicating whether to use ordinal day for the monthly recurrence pattern.
getOccurrences()
public final int getOccurrences()
Gets a number of occurrences of the recurring task.
Returns: int - a number of occurrences of the recurring task.
getRecurrencePattern()
public final int getRecurrencePattern()
Gets a recurrence pattern of the recurring task.
Can be one of the values of RecurrencePattern(getRecurrencePattern()/setRecurrencePattern(int)) enumeration.
Returns: int - a recurrence pattern of the recurring task.
getStartDate()
public final Date getStartDate()
Gets the date for the occurrences to begin.
Returns: java.util.Date - the date for the occurrences to begin.
getTask()
public final Task getTask()
Gets the parent task of this instance of RecurringTaskInfo class.
Returns: Task - the parent task of this instance of RecurringTaskInfo class.
getUseEndDate()
public final boolean getUseEndDate()
Gets a value indicating whether to use the end date or a number of occurrences for the recurring task.
Returns: boolean - a value indicating whether to use the end date or a number of occurrences for the recurring task.
getWeeklyDays()
public final int getWeeklyDays()
Gets a collection of days used in the weekly recurrence pattern.
Returns: int - a collection of days used in the weekly recurrence pattern.
getWeeklyRepetitions()
public final int getWeeklyRepetitions()
Gets a number of repetitions for the weekly recurrence pattern.
Returns: int - a number of repetitions for the weekly recurrence pattern.
getYearlyDate()
public final Date getYearlyDate()
Gets a date for the yearly recurrence pattern.
Returns: java.util.Date - a date for the yearly recurrence pattern.
getYearlyOrdinalDay()
public final int getYearlyOrdinalDay()
Gets a weekday of the yearly recurrence pattern when using ordinal day.
Can be one of the values of DayOfWeek enumeration.
Returns: int - a weekday of the yearly recurrence pattern when using ordinal day.
getYearlyOrdinalMonth()
public final int getYearlyOrdinalMonth()
Gets a month of the yearly recurrence pattern when using ordinal day.
Can be one of the values of Month enumeration.
Returns: int - a month of the yearly recurrence pattern when using ordinal day.
getYearlyOrdinalNumber()
public final int getYearlyOrdinalNumber()
Gets an ordinal number of the yearly recurrence pattern.
Can be one of the values of OrdinalNumber enumeration.
Returns: int - an ordinal number of the yearly recurrence pattern.
getYearlyUseOrdinalDay()
public final boolean getYearlyUseOrdinalDay()
Gets a value indicating whether to use ordinal day for the yearly recurrence pattern.
Returns: boolean - a value indicating whether to use ordinal day for the yearly recurrence pattern.
setDailyRepetitions(int value)
public final void setDailyRepetitions(int value)
Sets a number of repetitions for the daily recurrence pattern.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int | a number of repetitions for the daily recurrence pattern. |
setDailyUseWorkdays(boolean value)
public final void setDailyUseWorkdays(boolean value)
Sets a value indicating whether to use workdays for the daily recurrence pattern.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | a value indicating whether to use workdays for the daily recurrence pattern. |
setDuration(Duration value)
public final void setDuration(Duration value)
Sets the duration for one occurrence of the recurring task.
the instance of Duration(getDuration()/setDuration(Duration)) class.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | Duration | the duration for one occurrence of the recurring task. |
setEndDate(Date value)
public final void setEndDate(Date value)
Sets the date for the occurrences to end.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.util.Date | the date for the occurrences to end. |
setMonthlyDay(int value)
public final void setMonthlyDay(int value)
Sets a number of day of the monthly recurrence pattern.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int | a number of day of the monthly recurrence pattern. |
setMonthlyOrdinalDay(int value)
public final void setMonthlyOrdinalDay(int value)
Sets a day of the monthly recurrence pattern when using ordinal day.
Can be one of the values of DayOfWeek enumeration.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int | a day of the monthly recurrence pattern when using ordinal day. |
setMonthlyOrdinalNumber(int value)
public final void setMonthlyOrdinalNumber(int value)
Sets an ordinal number of the monthly recurrence pattern.
Can be one of the values of OrdinalNumber enumeration.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int | an ordinal number of the monthly recurrence pattern. |
setMonthlyOrdinalRepetitions(int value)
public final void setMonthlyOrdinalRepetitions(int value)
Sets a number of repetitions for the monthly recurrence pattern when using ordinal day.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int | a number of repetitions for the monthly recurrence pattern when using ordinal day. |
setMonthlyRepetitions(int value)
public final void setMonthlyRepetitions(int value)
Sets a number of repetitions for the monthly recurrence pattern.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int | a number of repetitions for the monthly recurrence pattern. |
setMonthlyUseOrdinalDay(boolean value)
public final void setMonthlyUseOrdinalDay(boolean value)
Sets a value indicating whether to use ordinal day for the monthly recurrence pattern.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | a value indicating whether to use ordinal day for the monthly recurrence pattern. |
setOccurrences(int value)
public final void setOccurrences(int value)
Sets a number of occurrences of the recurring task.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int | a number of occurrences of the recurring task. |
setRecurrencePattern(int value)
public final void setRecurrencePattern(int value)
Sets a recurrence pattern of the recurring task.
Can be one of the values of RecurrencePattern(getRecurrencePattern()/setRecurrencePattern(int)) enumeration.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int | a recurrence pattern of the recurring task. |
setStartDate(Date value)
public final void setStartDate(Date value)
Sets the date for the occurrences to begin.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.util.Date | the date for the occurrences to begin. |
setUseEndDate(boolean value)
public final void setUseEndDate(boolean value)
Sets a value indicating whether to use the end date or a number of occurrences for the recurring task.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | a value indicating whether to use the end date or a number of occurrences for the recurring task. |
setWeeklyDays(int value)
public final void setWeeklyDays(int value)
Sets a collection of days used in the weekly recurrence pattern.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int | a collection of days used in the weekly recurrence pattern. |
setWeeklyRepetitions(int value)
public final void setWeeklyRepetitions(int value)
Sets a number of repetitions for the weekly recurrence pattern.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int | a number of repetitions for the weekly recurrence pattern. |
setYearlyDate(Date value)
public final void setYearlyDate(Date value)
Sets a date for the yearly recurrence pattern.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.util.Date | a date for the yearly recurrence pattern. |
setYearlyOrdinalDay(int value)
public final void setYearlyOrdinalDay(int value)
Sets a weekday of the yearly recurrence pattern when using ordinal day.
Can be one of the values of DayOfWeek enumeration.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int | a weekday of the yearly recurrence pattern when using ordinal day. |
setYearlyOrdinalMonth(int value)
public final void setYearlyOrdinalMonth(int value)
Sets a month of the yearly recurrence pattern when using ordinal day.
Can be one of the values of Month enumeration.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int | a month of the yearly recurrence pattern when using ordinal day. |
setYearlyOrdinalNumber(int value)
public final void setYearlyOrdinalNumber(int value)
Sets an ordinal number of the yearly recurrence pattern.
Can be one of the values of OrdinalNumber enumeration.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int | an ordinal number of the yearly recurrence pattern. |
setYearlyUseOrdinalDay(boolean value)
public final void setYearlyUseOrdinalDay(boolean value)
Sets a value indicating whether to use ordinal day for the yearly recurrence pattern.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | a value indicating whether to use ordinal day for the yearly recurrence pattern. |