Interface EntityCalendarDataProvider

All Superinterfaces:
CalendarDataProvider
All Known Implementing Classes:
AbstractEntityCalendarDataProvider, ContainerCalendarDataProvider, EntityCalendarDataRetriever

public interface EntityCalendarDataProvider extends CalendarDataProvider
Base interface for data providers that work with entities, containing property names to retrieve values for CalendarEvent entities.
  • Method Details

    • getGroupIdProperty

      @Nullable String getGroupIdProperty()
      Returns:
      a group ID property or null if not set
    • setGroupIdProperty

      void setGroupIdProperty(@Nullable String groupIdProperty)
      Sets a group ID property.
      Parameters:
      groupIdProperty - group ID property of entity
      See Also:
    • getAllDayProperty

      @Nullable String getAllDayProperty()
      Returns:
      an all-day property or null if not set
    • setAllDayProperty

      void setAllDayProperty(@Nullable String allDayProperty)
      Sets an all-day property.
      Parameters:
      allDayProperty - all-day property of entity
      See Also:
    • getStartDateTimeProperty

      @Nullable String getStartDateTimeProperty()
      Returns:
      a start date-time property or null if not set
    • setStartDateTimeProperty

      void setStartDateTimeProperty(@Nullable String startProperty)
      Sets a start date-time property.
      Parameters:
      startProperty - start date-time property of entity
      See Also:
    • getEndDateTimeProperty

      @Nullable String getEndDateTimeProperty()
      Returns:
      an end date-time property or null if not set
    • setEndDateTimeProperty

      void setEndDateTimeProperty(@Nullable String endProperty)
      Sets an end date-time property.
      Parameters:
      endProperty - end date-time property of entity
      See Also:
    • getTitleProperty

      @Nullable String getTitleProperty()
      Returns:
      a title property or null if not set
    • setTitleProperty

      void setTitleProperty(@Nullable String titleProperty)
      Sets a title property.
      Parameters:
      titleProperty - title property of entity
      See Also:
    • getDescriptionProperty

      @Nullable String getDescriptionProperty()
      Returns:
      a description property or null if not set
    • setDescriptionProperty

      void setDescriptionProperty(@Nullable String descriptionProperty)
      Sets a description property.
      Parameters:
      descriptionProperty - description property of entity
      See Also:
    • getInteractiveProperty

      @Nullable String getInteractiveProperty()
      Returns:
      an interactive property or null if not set
    • setInteractiveProperty

      void setInteractiveProperty(@Nullable String interactiveProperty)
      Sets an interactive property.
      Parameters:
      interactiveProperty - interactive property of entity
      See Also:
    • getClassNamesProperty

      @Nullable String getClassNamesProperty()
      Returns:
      a class names property or null if not set
    • setClassNamesProperty

      void setClassNamesProperty(@Nullable String classNamesProperty)
      Sets a class names property.
      Parameters:
      classNamesProperty - class names property of entity
      See Also:
    • getStartEditableProperty

      @Nullable String getStartEditableProperty()
      Returns:
      a start editable property or null if not set
    • setStartEditableProperty

      void setStartEditableProperty(@Nullable String startEditableProperty)
      Sets a start editable property.
      Parameters:
      startEditableProperty - start editable property of entity
      See Also:
    • getDurationEditableProperty

      @Nullable String getDurationEditableProperty()
      Returns:
      a duration editable property or null if not set
    • setDurationEditableProperty

      void setDurationEditableProperty(@Nullable String durationEditableProperty)
      Sets a duration editable property.
      Parameters:
      durationEditableProperty - duration editable property of entity
      See Also:
    • getDisplayProperty

      @Nullable String getDisplayProperty()
      Returns:
      a display property or null if not set
    • setDisplayProperty

      void setDisplayProperty(@Nullable String displayProperty)
      Sets a display property.
      Parameters:
      displayProperty - display property of entity
      See Also:
    • getOverlapProperty

      @Nullable String getOverlapProperty()
      Returns:
      an overlap property or null if not set
    • setOverlapProperty

      void setOverlapProperty(@Nullable String overlapProperty)
      Sets an overlap property.
      Parameters:
      overlapProperty - overlap property of entity
      See Also:
    • getConstraintProperty

      @Nullable String getConstraintProperty()
      Returns:
      a constraint property or null if not set
    • setConstraintProperty

      void setConstraintProperty(@Nullable String constraintProperty)
      Sets a constraint property.
      Parameters:
      constraintProperty - constraint property of entity
      See Also:
    • getBackgroundColorProperty

      @Nullable String getBackgroundColorProperty()
      Returns:
      a background color property or null if not set
    • setBackgroundColorProperty

      void setBackgroundColorProperty(@Nullable String backgroundColorProperty)
      Sets a background color property.
      Parameters:
      backgroundColorProperty - background color property of entity
      See Also:
    • getBorderColorProperty

      @Nullable String getBorderColorProperty()
      Returns:
      a border color property or null if not set
    • setBorderColorProperty

      void setBorderColorProperty(@Nullable String borderColorProperty)
      Sets a border color property.
      Parameters:
      borderColorProperty - border color property of entity
      See Also:
    • getTextColorProperty

      @Nullable String getTextColorProperty()
      Returns:
      a text color property or null if not set
    • setTextColorProperty

      void setTextColorProperty(@Nullable String textColorProperty)
      Sets a text color property.
      Parameters:
      textColorProperty - text color property of entity
      See Also:
    • getAdditionalProperties

      List<String> getAdditionalProperties()
      Returns:
      list of additional properties of entity
    • setAdditionalProperties

      void setAdditionalProperties(@Nullable List<String> additionalProperties)
      Sets a list of additional properties.
      Parameters:
      additionalProperties - a list of additional properties of entity
      See Also:
    • getRecurringDaysOfWeekProperty

      @Nullable String getRecurringDaysOfWeekProperty()
      Returns:
      a recurring days of week property or null if not set
    • setRecurringDaysOfWeekProperty

      void setRecurringDaysOfWeekProperty(@Nullable String recurringDaysOfWeekProperty)
      Sets a recurring days of week property.
      Parameters:
      recurringDaysOfWeekProperty - a recurring days of week property of entity
      See Also:
    • getRecurringStartDateProperty

      @Nullable String getRecurringStartDateProperty()
      Returns:
      a recurring start date property or null if not set
    • setRecurringStartDateProperty

      void setRecurringStartDateProperty(@Nullable String recurringStartDateProperty)
      Sets a recurring start date property.
      Parameters:
      recurringStartDateProperty - a recurring start date property of entity
      See Also:
    • getRecurringEndDateProperty

      @Nullable String getRecurringEndDateProperty()
      Returns:
      a recurring end date property or null if not set
    • setRecurringEndDateProperty

      void setRecurringEndDateProperty(@Nullable String recurringEndDateProperty)
      Sets a recurring end date property.
      Parameters:
      recurringEndDateProperty - a recurring end date property of entity
      See Also:
    • getRecurringStartTimeProperty

      @Nullable String getRecurringStartTimeProperty()
      Returns:
      a recurring start time property or null if not set
    • setRecurringStartTimeProperty

      void setRecurringStartTimeProperty(@Nullable String recurringStartTimeProperty)
      Sets a recurring start time property.
      Parameters:
      recurringStartTimeProperty - a recurring start time property of entity
      See Also:
    • getRecurringEndTimeProperty

      @Nullable String getRecurringEndTimeProperty()
      Returns:
      a recurring end time property or null if not set
    • setRecurringEndTimeProperty

      void setRecurringEndTimeProperty(@Nullable String recurringEndTimeProperty)
      Sets a recurring end time property.
      Parameters:
      recurringEndTimeProperty - a recurring end time property of entity
      See Also:
    • getEntityMetaClass

      MetaClass getEntityMetaClass()
      Returns:
      entity meta class
    • getStartPropertyJavaType

      @Nullable Class<?> getStartPropertyJavaType()
      Returns:
      java type of start date-time property or null if property is not specified
    • getEndPropertyJavaType

      @Nullable Class<?> getEndPropertyJavaType()
      Returns:
      java type of end date-time property or null if property is not specified