Package org.opencms.widgets.serialdate

Interface I_CmsSerialDateBean

All Known Implementing Classes:
A_CmsSerialDateBean, CmsSerialDateBeanDaily, CmsSerialDateBeanIndividual, CmsSerialDateBeanMonthly, CmsSerialDateBeanMonthlyWeeks, CmsSerialDateBeanSingle, CmsSerialDateBeanWeekly, CmsSerialDateBeanWorkingDays, CmsSerialDateBeanYearly, CmsSerialDateBeanYearlyWeekday
public interface I_CmsSerialDateBean
Interface for serial date beans. Serial date beans allow easy access to values stored by the CmsSerialDateWidget.

  • Method Summary

    Modifier and Type
    Method
    Description
    SortedSet<Date>
    getDates()
    Returns all dates of the whole series as Date objects, sorted ascendingly.
    SortedSet<Long>
    getDatesAsLong()
    Returns all dates of the whole series in milliseconds, sorted ascendingly.
    Long
    getEventDuration()
    Returns the duration of a single event in milliseconds, or null if no end date is specified.
    SortedSet<Date>
    getExceptions()
    Returns all exceptions from the series, sorted ascendingly.
    boolean
    hasTooManyDates()
    Returns a flag, indicating if the series has more dates than allowed.

  • Method Details

    • getDates

      SortedSet<Date> getDates()
      Returns all dates of the whole series as Date objects, sorted ascendingly.
      Returns:
      all dates of the whole series as Date objects, sorted ascendingly.

    • getDatesAsLong

      SortedSet<Long> getDatesAsLong()
      Returns all dates of the whole series in milliseconds, sorted ascendingly.
      Returns:
      all dates of the whole series in milliseconds, sorted ascendingly.

    • getEventDuration

      Long getEventDuration()
      Returns the duration of a single event in milliseconds, or null if no end date is specified.
      Returns:
      the duration of a single event in milliseconds, or null if no end date is specified.

    • getExceptions

      SortedSet<Date> getExceptions()
      Returns all exceptions from the series, sorted ascendingly.
      Returns:
      all exceptions from the series, sorted ascendingly.

    • hasTooManyDates

      boolean hasTooManyDates()
      Returns a flag, indicating if the series has more dates than allowed.
      Returns:
      a flag, indicating if the series has more dates than allowed.