Class RecurringTaskInfo
- java.lang.Object
-
- com.aspose.tasks.RecurringTaskInfo
-
public class RecurringTaskInfo extends Object
Represents the details of a recurring task in a project.
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description int
getDailyRepetitions()
Gets a number of repetitions for the daily recurrence pattern.boolean
getDailyUseWorkdays()
Gets a value indicating whether to use workdays for the daily recurrence pattern.Duration
getDuration()
Gets the duration for one occurrence of the recurring task.Date
getEndDate()
Gets the date for the occurrences to end.int
getMonthlyDay()
Gets a number of day of the monthly recurrence pattern.int
getMonthlyOrdinalDay()
Gets a day of the monthly recurrence pattern when using ordinal day.int
getMonthlyOrdinalNumber()
Gets an ordinal number of the monthly recurrence pattern.int
getMonthlyOrdinalRepetitions()
Gets a number of repetitions for the monthly recurrence pattern when using ordinal day.int
getMonthlyRepetitions()
Gets a number of repetitions for the monthly recurrence pattern.boolean
getMonthlyUseOrdinalDay()
Gets a value indicating whether to use ordinal day for the monthly recurrence pattern.int
getOccurrences()
Gets a number of occurrences of the recurring task.int
getRecurrencePattern()
Gets a recurrence pattern of the recurring task.Date
getStartDate()
Gets the date for the occurrences to begin.Task
getTask()
Gets the parent task of this instance ofRecurringTaskInfo
class.boolean
getUseEndDate()
Gets a value indicating whether to use the end date or a number of occurrences for the recurring task.int
getWeeklyDays()
Gets a collection of days used in the weekly recurrence pattern.int
getWeeklyRepetitions()
Gets a number of repetitions for the weekly recurrence pattern.Date
getYearlyDate()
Gets a date for the yearly recurrence pattern.int
getYearlyOrdinalDay()
Gets a weekday of the yearly recurrence pattern when using ordinal day.int
getYearlyOrdinalMonth()
Gets a month of the yearly recurrence pattern when using ordinal day.int
getYearlyOrdinalNumber()
Gets an ordinal number of the yearly recurrence pattern.boolean
getYearlyUseOrdinalDay()
Gets a value indicating whether to use ordinal day for the yearly recurrence pattern.void
setDailyRepetitions(int value)
Sets a number of repetitions for the daily recurrence pattern.void
setDailyUseWorkdays(boolean value)
Sets a value indicating whether to use workdays for the daily recurrence pattern.void
setDuration(Duration value)
Sets the duration for one occurrence of the recurring task.void
setEndDate(Date value)
Sets the date for the occurrences to end.void
setMonthlyDay(int value)
Sets a number of day of the monthly recurrence pattern.void
setMonthlyOrdinalDay(int value)
Sets a day of the monthly recurrence pattern when using ordinal day.void
setMonthlyOrdinalNumber(int value)
Sets an ordinal number of the monthly recurrence pattern.void
setMonthlyOrdinalRepetitions(int value)
Sets a number of repetitions for the monthly recurrence pattern when using ordinal day.void
setMonthlyRepetitions(int value)
Sets a number of repetitions for the monthly recurrence pattern.void
setMonthlyUseOrdinalDay(boolean value)
Sets a value indicating whether to use ordinal day for the monthly recurrence pattern.void
setOccurrences(int value)
Sets a number of occurrences of the recurring task.void
setRecurrencePattern(int value)
Sets a recurrence pattern of the recurring task.void
setStartDate(Date value)
Sets the date for the occurrences to begin.void
setUseEndDate(boolean value)
Sets a value indicating whether to use the end date or a number of occurrences for the recurring task.void
setWeeklyDays(int value)
Sets a collection of days used in the weekly recurrence pattern.void
setWeeklyRepetitions(int value)
Sets a number of repetitions for the weekly recurrence pattern.void
setYearlyDate(Date value)
Sets a date for the yearly recurrence pattern.void
setYearlyOrdinalDay(int value)
Sets a weekday of the yearly recurrence pattern when using ordinal day.void
setYearlyOrdinalMonth(int value)
Sets a month of the yearly recurrence pattern when using ordinal day.void
setYearlyOrdinalNumber(int value)
Sets an ordinal number of the yearly recurrence pattern.void
setYearlyUseOrdinalDay(boolean value)
Sets a value indicating whether to use ordinal day for the yearly recurrence pattern.
-
-
-
Method Detail
-
getDailyRepetitions
public final int getDailyRepetitions()
Gets a number of repetitions for the daily recurrence pattern.
- Returns:
- a number of repetitions for the daily recurrence pattern.
-
setDailyRepetitions
public final void setDailyRepetitions(int value)
Sets a number of repetitions for the daily recurrence pattern.
- Parameters:
value
- 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:
- a value indicating whether to use workdays for the daily recurrence pattern.
-
setDailyUseWorkdays
public final void setDailyUseWorkdays(boolean value)
Sets a value indicating whether to use workdays for the daily recurrence pattern.
- Parameters:
value
- 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 ofDuration
(getDuration()
/setDuration(Duration)
) class.- Returns:
- the duration for one occurrence of the recurring task.
-
setDuration
public final void setDuration(Duration value)
Sets the duration for one occurrence of the recurring task.
the instance ofDuration
(getDuration()
/setDuration(Duration)
) class.- Parameters:
value
- the duration for one occurrence of the recurring task.
-
getEndDate
public final Date getEndDate()
Gets the date for the occurrences to end.
- Returns:
- the date for the occurrences to end.
-
setEndDate
public final void setEndDate(Date value)
Sets the date for the occurrences to end.
- Parameters:
value
- the date for the occurrences to end.
-
getMonthlyDay
public final int getMonthlyDay()
Gets a number of day of the monthly recurrence pattern.
- Returns:
- a number of day of the monthly recurrence pattern.
-
setMonthlyDay
public final void setMonthlyDay(int value)
Sets a number of day of the monthly recurrence pattern.
- Parameters:
value
- 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 ofDayOfWeek
enumeration.- Returns:
- a day of the monthly recurrence pattern when using ordinal day.
-
setMonthlyOrdinalDay
public final void setMonthlyOrdinalDay(int value)
Sets a day of the monthly recurrence pattern when using ordinal day.
Can be one of the values ofDayOfWeek
enumeration.- Parameters:
value
- 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 ofOrdinalNumber
enumeration.- Returns:
- an ordinal number of the monthly recurrence pattern.
-
setMonthlyOrdinalNumber
public final void setMonthlyOrdinalNumber(int value)
Sets an ordinal number of the monthly recurrence pattern.
Can be one of the values ofOrdinalNumber
enumeration.- Parameters:
value
- 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:
- a number of repetitions for the monthly recurrence pattern when using ordinal day.
-
setMonthlyOrdinalRepetitions
public final void setMonthlyOrdinalRepetitions(int value)
Sets a number of repetitions for the monthly recurrence pattern when using ordinal day.
- Parameters:
value
- 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:
- a number of repetitions for the monthly recurrence pattern.
-
setMonthlyRepetitions
public final void setMonthlyRepetitions(int value)
Sets a number of repetitions for the monthly recurrence pattern.
- Parameters:
value
- 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:
- a value indicating whether to use ordinal day for the monthly recurrence pattern.
-
setMonthlyUseOrdinalDay
public final void setMonthlyUseOrdinalDay(boolean value)
Sets a value indicating whether to use ordinal day for the monthly recurrence pattern.
- Parameters:
value
- 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:
- a number of occurrences of the recurring task.
-
setOccurrences
public final void setOccurrences(int value)
Sets a number of occurrences of the recurring task.
- Parameters:
value
- 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 ofRecurrencePattern
(getRecurrencePattern()
/setRecurrencePattern(int)
) enumeration.- Returns:
- a recurrence pattern of the recurring task.
-
setRecurrencePattern
public final void setRecurrencePattern(int value)
Sets a recurrence pattern of the recurring task.
Can be one of the values ofRecurrencePattern
(getRecurrencePattern()
/setRecurrencePattern(int)
) enumeration.- Parameters:
value
- a recurrence pattern of the recurring task.
-
getStartDate
public final Date getStartDate()
Gets the date for the occurrences to begin.
- Returns:
- the date for the occurrences to begin.
-
setStartDate
public final void setStartDate(Date value)
Sets the date for the occurrences to begin.
- Parameters:
value
- the date for the occurrences to begin.
-
getTask
public final Task getTask()
Gets the parent task of this instance of
RecurringTaskInfo
class.- Returns:
- 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:
- a value indicating whether to use the end date or a number of occurrences for the recurring task.
-
setUseEndDate
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:
value
- 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:
- a collection of days used in the weekly recurrence pattern.
-
setWeeklyDays
public final void setWeeklyDays(int value)
Sets a collection of days used in the weekly recurrence pattern.
- Parameters:
value
- 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:
- a number of repetitions for the weekly recurrence pattern.
-
setWeeklyRepetitions
public final void setWeeklyRepetitions(int value)
Sets a number of repetitions for the weekly recurrence pattern.
- Parameters:
value
- a number of repetitions for the weekly recurrence pattern.
-
getYearlyDate
public final Date getYearlyDate()
Gets a date for the yearly recurrence pattern.
- Returns:
- a date for the yearly recurrence pattern.
-
setYearlyDate
public final void setYearlyDate(Date value)
Sets a date for the yearly recurrence pattern.
- Parameters:
value
- 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 ofDayOfWeek
enumeration.- Returns:
- a weekday of the yearly recurrence pattern when using ordinal day.
-
setYearlyOrdinalDay
public final void setYearlyOrdinalDay(int value)
Sets a weekday of the yearly recurrence pattern when using ordinal day.
Can be one of the values ofDayOfWeek
enumeration.- Parameters:
value
- 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 ofMonth
enumeration.- Returns:
- a month of the yearly recurrence pattern when using ordinal day.
-
setYearlyOrdinalMonth
public final void setYearlyOrdinalMonth(int value)
Sets a month of the yearly recurrence pattern when using ordinal day.
Can be one of the values ofMonth
enumeration.- Parameters:
value
- 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 ofOrdinalNumber
enumeration.- Returns:
- an ordinal number of the yearly recurrence pattern.
-
setYearlyOrdinalNumber
public final void setYearlyOrdinalNumber(int value)
Sets an ordinal number of the yearly recurrence pattern.
Can be one of the values ofOrdinalNumber
enumeration.- Parameters:
value
- 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:
- a value indicating whether to use ordinal day for the yearly recurrence pattern.
-
setYearlyUseOrdinalDay
public final void setYearlyUseOrdinalDay(boolean value)
Sets a value indicating whether to use ordinal day for the yearly recurrence pattern.
- Parameters:
value
- a value indicating whether to use ordinal day for the yearly recurrence pattern.
-
-