Package com.redwood.scheduler.api.date

Interface RecurrenceInfo

  • public interface RecurrenceInfo
    Retrieve recurrence information

    • Method Detail

      • getPatternType

        char getPatternType()

      • getDayInterval

        Long getDayInterval()
        Every <getDayInterval> days
        Returns:
        The number of days to the next occurrence, 0 if the pattern is not daily

      • getWeekInterval

        Long getWeekInterval()
        Every <getWeekInterval> weeks
        Returns:
        The number of weeks to the next occurrence

      • getWeekDays

        String getWeekDays()
        Days of the week, coded in a string of 0 (job does not run) and 1 (job runs). The string holds Sunday to Saturday.
        Returns:
        String with coded weekdays, an empty string if the pattern is not weekly

      • isWeekdayChecked

        boolean isWeekdayChecked​(int aWeekdayIndex)
        Parameters:
        aWeekdayIndex - for weekdays, Sunday = 0, Saturday = 6.
        Returns:
        true if job runs on the requested weekday
        Throws:
        IndexOutOfBoundsException - - if the index argument is negative or not less than the number of days in a week, or if the pattern is not weekly

      • getMonthDayType

        Long getMonthDayType()
        Returns:
        The type of day: Calendar.SUN .. Calendar.SAT, DateTimeZone.ANYDAY, WEEKEND, WORKDAY

      • getMonthInterval

        Long getMonthInterval()
        Every <getMonthInterval> months
        Returns:
        The number of months to the next occurrence, 0 if the pattern is not monthly

      • getMonthDayOrWeekNumber

        Long getMonthDayOrWeekNumber()
        Returns:
        the day number for ANYDAY, WORKDAY; the week number for all others, 0 if the pattern is not monthly

      • getYearDayType

        Long getYearDayType()
        Returns:
        The type of day: Calendar.SUN .. Calendar.SAT, DateTimeZone.ANYDAY, WEEKEND, WORKDAY, 0 if the pattern is not yearly

      • getYearDayOrWeekNumber

        Long getYearDayOrWeekNumber()
        Returns:
        the day in the month for ANYDAY, WORKDAY; the week number for all others, 0 if the pattern is not yearly

      • getYearMonth

        Long getYearMonth()
        Returns:
        the month in the year in which the jobs must run, 0 if the pattern is not yearly

      • getDates

        String getDates()
        Returns:
        dates as a comma-separated list in YYYYMMDD format, or an empty string if the recurrence does not define any Dates

      • getDateTimeZones

        List<DateTimeZone> getDateTimeZones()
        Returns:
        dates as a sorted DateTimeZone List. The list if empty if the does not define any Dates

      • isRangeExternal

        boolean isRangeExternal()
        Returns:
        true if the range is defined on the job group, false if the range is defined in the recurrence pattern string (pre-M33)

      • getEndDate

        DateTimeZone getEndDate()
        Returns:
        the end date of the recurrence

      • getRequiredOccurrencesCount

        int getRequiredOccurrencesCount()
        Returns:
        the number of jobs that must be presubmitted for this recurrence

      • isNeverEnding

        boolean isNeverEnding()
        Returns:
        true if the recurrence does not stop, otherwise the recurrence stops by end date or required number of occurrences