Package org.opencms.acacia.shared

Interface I_CmsSerialDateValue

All Known Implementing Classes:
A_CmsSerialDateValue, CmsSerialDateValue
public interface I_CmsSerialDateValue
Interface to access serial date values easily. Used on client and server.

  • Field Details

  • Method Details

    • endsAtMidNight

      boolean endsAtMidNight()
      Returns a flag, indicating if the event ends at midnight.
      Returns:
      a flag, indicating if the event ends at midnight.

    • getDateType

      I_CmsSerialDateValue.DateType getDateType()
      Returns the type of the specified date.
      Returns:
      the type of the specified date.

    • getDayOfMonth

      int getDayOfMonth()
      Returns the day of the month, the events should take place.
      Returns:
      the day of the month, the events should take place.

    • getEnd

      Date getEnd()
      Returns the end time of the events.
      Returns:
      the end time of the events.

    • getEndType

      I_CmsSerialDateValue.EndType getEndType()
      Returns the end type of the event series.
      Returns:
      the end type of the event series.

    • getExceptions

      SortedSet<Date> getExceptions()
      Returns the dates, where the event should not take place.
      Returns:
      the dates, where the event should not take place.

    • getIndividualDates

      SortedSet<Date> getIndividualDates()
      Returns the dates of an individual date series.
      Returns:
      the dates of an individual date series.

    • getInterval

      int getInterval()
      Returns the pattern type specific interval of the event.
      Returns:
      the pattern type specific interval of the event.

    • getMonth

      I_CmsSerialDateValue.Month getMonth()
      Returns the month in which the events take place.
      Returns:
      the month in which the events take place.

    • getOccurrences

      int getOccurrences()
      Returns the number of occurrences of the event.
      Returns:
      the number of occurrences of the event.

    • getParentSeriesId

      CmsUUID getParentSeriesId()
      Returns the uuid of the content that holds the series, the current event was extracted from. Or null if the current event series was not extracted from another one.
      Returns:
      the uuid of the original series' content, or null, if the event is not extracted from another event series.

    • getPatternType

      I_CmsSerialDateValue.PatternType getPatternType()
      Returns the pattern type of the event series.
      Returns:
      the pattern type of the event series.

    • getSeriesEndDate

      Date getSeriesEndDate()
      Returns the date of the last day, events of the series should take place.
      Returns:
      the date of the last day, events of the series should take place.

    • getStart

      Date getStart()
      Returns the start time of the events.
      Returns:
      the start time of the events.

    • getWeekDay

      I_CmsSerialDateValue.WeekDay getWeekDay()
      Returns the week day where the event should take place.
      Returns:
      the week day where the event should take place.

    • getWeekDays

      SortedSet<I_CmsSerialDateValue.WeekDay> getWeekDays()
      Returns the week days where the event should take place.
      Returns:
      the week days where the event should take place.

    • getWeekOfMonth

      I_CmsSerialDateValue.WeekOfMonth getWeekOfMonth()
      Returns the week of the month, the event should take place.
      Returns:
      the week of the month, the event should take place.

    • getWeeksOfMonth

      SortedSet<I_CmsSerialDateValue.WeekOfMonth> getWeeksOfMonth()
      Returns the weeks of the month, the event should take place.
      Returns:
      the weeks of the month, the event should take place.

    • isCurrentTillEnd

      boolean isCurrentTillEnd()
      Returns a flag, indicating if the events should be treated as "current" till they end (or only till they start).
      Returns:
      true if the event is "current" till it ends, false if it is current till it starts.

    • isEveryWorkingDay

      boolean isEveryWorkingDay()
      Returns a flag, indicating if the event should take place every working day.
      Returns:
      a flag, indicating if the event should take place every working day.

    • isFromOtherSeries

      boolean isFromOtherSeries()
      Returns a flag, indicating if the event is extracted from another series.
      Returns:
      a flag, indicating if the event is extracted from another series.

    • isValid

      boolean isValid()
      Returns a flag, indicating if the value specifies a valid date (series).
      Returns:
      a flag, indicating if the value specifies a valid date (series).

    • isWholeDay

      boolean isWholeDay()
      Returns a flag, indicating if the event last the whole day/whole days.
      Returns:
      a flag, indicating if the event last the whole day/whole days.