Interface ICalendarItem

All Superinterfaces:
Comparable<ICalendarItem>
All Known Implementing Classes:
AbstractCalendarItem, CalendarItemCentury, CalendarItemDay, CalendarItemMonth, CalendarItemWeek, CalendarItemYear

public interface ICalendarItem extends Comparable<ICalendarItem>
Represents a single selectable item in a calendar navigation (e.g. a year, month, or day entry). Each item has a display name, a numeric value used for ordering, a hit count reflecting how many records fall within it, and a selected state.
  • Method Details

    • getName

      String getName()
      getName.
      Returns:
      the display name of this calendar item
    • getValue

      int getValue()
      getValue.
      Returns:
      a int.
    • getHits

      int getHits()
      getHits.
      Returns:
      a int.
    • setHits

      void setHits(int hits)
      setHits.
      Parameters:
      hits - number of search hits for this item
    • isSelected

      boolean isSelected()
      isSelected.
      Returns:
      true if this calendar item is currently selected, false otherwise
    • setSelected

      void setSelected(boolean selected)
      setSelected.
      Parameters:
      selected - true to mark this item as selected
    • compareTo

      default int compareTo(ICalendarItem other)
      Specified by:
      compareTo in interface Comparable<ICalendarItem>