com.aspose.tasks

Interfaces

Classes

Exceptions

com.aspose.tasks

Class 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 and Description
      int getDailyRepetitions()
      Specifies a number of repetitions for the daily recurrence pattern.
      boolean getDailyUseWorkdays()
      Returns a flag which determines whether to use workdays for the daily recurrence pattern.
      Duration getDuration()
      Specifies the duration for one occurrence of the recurring task.
      Date getEndDate()
      Returns the date for the occurrences to end.
      int getMonthlyDay()
      Returns a number of day of the monthly recurrence pattern.
      int getMonthlyOrdinalDay()
      Returns a day of the monthly recurrence pattern when using ordinal day.
      int getMonthlyOrdinalNumber()
      Returns an ordinal number of the monthly recurrence pattern.
      int getMonthlyOrdinalRepetitions()
      Returns a number of repetitions for the monthly recurrence pattern when using ordinal day.
      int getMonthlyRepetitions()
      Returns a number of repetitions for the monthly recurrence pattern.
      boolean getMonthlyUseOrdinalDay()
      Returns a flag which determines whether to use ordinal day for the monthly recurrence pattern.
      int getOccurrences()
      Returns a number of occurrences of the recurring task.
      int getRecurrencePattern()
      Returns a recurrence pattern of the recurring task.
      Date getStartDate()
      Returns the date for the occurrences to begin.
      Task getTask()
      Returns the parent task of this instance of RecurringTaskInfo class.
      boolean getUseEndDate()
      Returns a flag which determines whether to use the end date or a number of occurrences for the recurring task.
      int getWeeklyDays()
      Returns a collection of days used in the weekly recurrence pattern (@code WeekdayType).
      int getWeeklyRepetitions()
      Returns a number of repetitions for the weekly recurrence pattern.
      Date getYearlyDate()
      Returns a date for the yearly recurrence pattern.
      int getYearlyOrdinalDay()
      Returns a weekday of the yearly recurrence pattern when using ordinal day.
      int getYearlyOrdinalMonth()
      Returns a month of the yearly recurrence pattern when using ordinal day.
      int getYearlyOrdinalNumber()
      Returns an ordinal number of the yearly recurrence pattern.
      boolean getYearlyUseOrdinalDay()
      Returns a flag which determines whether to use ordinal day for the yearly recurrence pattern.
      void setDailyRepetitions(int value)
      Specifies a number of repetitions for the daily recurrence pattern.
      void setDailyUseWorkdays(boolean value)
      Sets a flag which determines whether to use workdays for the daily recurrence pattern.
      void setDuration(Duration value)
      Specifies the duration for one occurrence of the recurring task.
      void setEndDate(Date value)
      Specifies the date for the occurrences to end.
      void setMonthlyDay(int value)
      Specifies 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)
      Specifies a number of repetitions for the monthly recurrence pattern when using ordinal day.
      void setMonthlyRepetitions(int value)
      Specifies a number of repetitions for the monthly recurrence pattern.
      void setMonthlyUseOrdinalDay(boolean value)
      Sets a flag which determines whether to use ordinal day for the monthly recurrence pattern.
      void setOccurrences(int value)
      Specifies a number of occurrences of the recurring task.
      void setRecurrencePattern(int value)
      Sets a recurrence pattern of the recurring task.
      void setStartDate(Date value)
      Specifies the date for the occurrences to begin.
      void setUseEndDate(boolean value)
      Sets a flag which determines whether to use the end date or a number of occurrences for the recurring task.
      void setWeeklyDays(int value)
      Specifies a collection of days used in the weekly recurrence pattern (@code WeekdayType).
      void setWeeklyRepetitions(int value)
      Specifies a number of repetitions for the weekly recurrence pattern.
      void setYearlyDate(Date value)
      Specifies a date for the yearly recurrence pattern.
      void setYearlyOrdinalDay(int value)
      Specifies a weekday of the yearly recurrence pattern when using ordinal day.
      void setYearlyOrdinalMonth(int value)
      Specifies a month of the yearly recurrence pattern when using ordinal day.
      void setYearlyOrdinalNumber(int value)
      Specifies an ordinal number of the yearly recurrence pattern.
      void setYearlyUseOrdinalDay(boolean value)
      Specifies a flag which determines whether to use ordinal day for the yearly recurrence pattern.
    • Method Detail

      • getDailyRepetitions

        public final int getDailyRepetitions()

        Specifies a number of repetitions for the daily recurrence pattern.

        Returns:
        returns a number of repetitions for the daily recurrence pattern.
      • setDailyRepetitions

        public final void setDailyRepetitions(int value)

        Specifies 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()

        Returns a flag which determines whether to use workdays for the daily recurrence pattern.

        Returns:
        returns a flag which determines whether to use workdays for the daily recurrence pattern.
      • setDailyUseWorkdays

        public final void setDailyUseWorkdays(boolean value)

        Sets a flag which determines whether to use workdays for the daily recurrence pattern.

        Parameters:
        value - a flag which determines whether to use workdays for the daily recurrence pattern.
      • getDuration

        public final Duration getDuration()

        Specifies the duration for one occurrence of the recurring task. the instance of Duration class.

        Returns:
        returns the instance of Duration class.
      • setDuration

        public final void setDuration(Duration value)

        Specifies the duration for one occurrence of the recurring task.

        Parameters:
        value - the instance of Duration class.
      • getEndDate

        public final Date getEndDate()

        Returns the date for the occurrences to end.

        Returns:
        returns the date for the occurrences to end.
      • setEndDate

        public final void setEndDate(Date value)

        Specifies the date for the occurrences to end.

        Parameters:
        value - the date for the occurrences to end.
      • getMonthlyDay

        public final int getMonthlyDay()

        Returns 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)
        Specifies 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()

        Returns a day of the monthly recurrence pattern when using ordinal day. Can be one of the values of DayOfWeek enum.

        Returns:
        returns a day of the monthly recurrence pattern when using ordinal day (one of the values of DayOfWeek enum).
      • 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 of DayOfWeek enum.
        Parameters:
        value - a day of the monthly recurrence pattern when using ordinal day (one of the values of DayOfWeek enum).
      • getMonthlyOrdinalNumber

        public final int getMonthlyOrdinalNumber()

        Returns an ordinal number of the monthly recurrence pattern. Can be one of the values of OrdinalNumber enum.

        Returns:
        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.
        Parameters:
        value - an ordinal number of the monthly recurrence pattern (one of the values of OrdinalNumber enum).
      • getMonthlyOrdinalRepetitions

        public final int getMonthlyOrdinalRepetitions()

        Returns a number of repetitions for the monthly recurrence pattern when using ordinal day.

        Returns:
        returns a number of repetitions for the monthly recurrence pattern when using ordinal day.
      • setMonthlyOrdinalRepetitions

        public final void setMonthlyOrdinalRepetitions(int value)
        Specifies 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()

        Returns a number of repetitions for the monthly recurrence pattern.

        Returns:
        returns a number of repetitions for the monthly recurrence pattern.
      • setMonthlyRepetitions

        public final void setMonthlyRepetitions(int value)
        Specifies 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()

        Returns a flag which determines whether to use ordinal day for the monthly recurrence pattern.

        Returns:
        returns a flag which determines whether to use ordinal day for the monthly recurrence pattern.
      • setMonthlyUseOrdinalDay

        public final void setMonthlyUseOrdinalDay(boolean value)
        Sets a flag which determines whether to use ordinal day for the monthly recurrence pattern.
        Parameters:
        value - a flag which determines whether to use ordinal day for the monthly recurrence pattern.
      • getOccurrences

        public final int getOccurrences()

        Returns a number of occurrences of the recurring task.

        Returns:
        returns a number of occurrences of the recurring task.
      • setOccurrences

        public final void setOccurrences(int value)

        Specifies a number of occurrences of the recurring task.

        Parameters:
        value - a number of occurrences of the recurring task.
      • getRecurrencePattern

        public final int getRecurrencePattern()

        Returns a recurrence pattern of the recurring task. Can be one of the values of RecurrencePattern enum.

        Returns:
        returns one of the values of RecurrencePattern enum.
      • setRecurrencePattern

        public final void setRecurrencePattern(int value)
        Sets a recurrence pattern of the recurring task.
        Parameters:
        value - one of the values of RecurrencePattern enum.
      • getStartDate

        public final Date getStartDate()

        Returns the date for the occurrences to begin.

        Returns:
        returns the date for the occurrences to begin.
      • setStartDate

        public final void setStartDate(Date value)
        Specifies the date for the occurrences to begin.
        Parameters:
        value - the date for the occurrences to begin.
      • getTask

        public final Task getTask()

        Returns the parent task of this instance of RecurringTaskInfo class.

        Returns:
        returns the parent task of this instance of RecurringTaskInfo class.
      • getUseEndDate

        public final boolean getUseEndDate()

        Returns a flag which determines whether to use the end date or a number of occurrences for the recurring task.

        Returns:
        returns a flag which determines whether to use the end date or a number of occurrences for the recurring task.
      • setUseEndDate

        public final void setUseEndDate(boolean value)

        Sets a flag which determines whether to use the end date or a number of occurrences for the recurring task.

        Parameters:
        value - a flag which determines whether to use the end date or a number of occurrences for the recurring task.
      • getWeeklyDays

        public final int getWeeklyDays()

        Returns a collection of days used in the weekly recurrence pattern (@code WeekdayType).

        Returns:
        returns a collection of days used in the weekly recurrence pattern (@code WeekdayType).
      • setWeeklyDays

        public final void setWeeklyDays(int value)

        Specifies a collection of days used in the weekly recurrence pattern (@code WeekdayType).

        Parameters:
        value - a collection of days used in the weekly recurrence pattern (@code WeekdayType).
      • getWeeklyRepetitions

        public final int getWeeklyRepetitions()

        Returns a number of repetitions for the weekly recurrence pattern.

        Returns:
        returns a number of repetitions for the weekly recurrence pattern.
      • setWeeklyRepetitions

        public final void setWeeklyRepetitions(int value)

        Specifies 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()

        Returns a date for the yearly recurrence pattern.

        Returns:
        returns a date for the yearly recurrence pattern.
      • setYearlyDate

        public final void setYearlyDate(Date value)
        Specifies a date for the yearly recurrence pattern.
        Parameters:
        value - a date for the yearly recurrence pattern.
      • getYearlyOrdinalDay

        public final int getYearlyOrdinalDay()

        Returns a weekday of the yearly recurrence pattern when using ordinal day. Can be one of the values of DayOfWeek enum.

        Returns:
        returns a weekday of the yearly recurrence pattern when using ordinal day (one of the values of DayOfWeek enum).
      • setYearlyOrdinalDay

        public final void setYearlyOrdinalDay(int value)
        Specifies a weekday of the yearly recurrence pattern when using ordinal day. Can be one of the values of DayOfWeek enum.
        Parameters:
        value - a weekday of the yearly recurrence pattern when using ordinal day (one of the values of DayOfWeek enum).
      • getYearlyOrdinalMonth

        public final int getYearlyOrdinalMonth()

        Returns a month of the yearly recurrence pattern when using ordinal day. Can be one of the values of Month enum.

        Returns:
        returns a month of the yearly recurrence pattern when using ordinal day (one of the values of Month enum).
      • setYearlyOrdinalMonth

        public final void setYearlyOrdinalMonth(int value)
        Specifies a month of the yearly recurrence pattern when using ordinal day.
        Parameters:
        value - a month of the yearly recurrence pattern when using ordinal day (one of the values of Month enum).
      • getYearlyOrdinalNumber

        public final int getYearlyOrdinalNumber()

        Returns an ordinal number of the yearly recurrence pattern. Can be one of the values of OrdinalNumber enum.

        Returns:
        returns an ordinal number of the yearly recurrence pattern (one of the values of OrdinalNumber enum).
      • setYearlyOrdinalNumber

        public final void setYearlyOrdinalNumber(int value)
        Specifies an ordinal number of the yearly recurrence pattern. Can be one of the values of OrdinalNumber enum.
        Parameters:
        value - an ordinal number of the yearly recurrence pattern (one of the values of OrdinalNumber enum).
      • getYearlyUseOrdinalDay

        public final boolean getYearlyUseOrdinalDay()

        Returns a flag which determines whether to use ordinal day for the yearly recurrence pattern.

        Returns:
        returns a flag which determines whether to use ordinal day for the yearly recurrence pattern.
      • setYearlyUseOrdinalDay

        public final void setYearlyUseOrdinalDay(boolean value)
        Specifies a flag which determines whether to use ordinal day for the yearly recurrence pattern.
        Parameters:
        value - a flag which determines whether to use ordinal day for the yearly recurrence pattern.