Package de.xima.fc.interfaces.appointment

Interface IAppointmentFreeSlotQueryParams

All Superinterfaces:
Serializable
public interface IAppointmentFreeSlotQueryParams extends Serializable
The parameters for a query that retrieves the available times of a AppointmentTemplate. Used by the appointment widget in the form: it sends a query to the appointment servlet.
Since:
6.5.0
Author:
XIMA MEDIA GmbH

  • Method Details

    • getAppointmentTemplateUUID

      UUID getAppointmentTemplateUUID()
      Returns:
      The appointment template for which to find the free slots.

    • getClientId

      long getClientId()
      Returns:
      The ID of the client to which to limit the search.

    • getRange

      com.google.common.collect.Range<LocalDateTime> getRange()
      Returns:
      The temporal range where to find the free slots.

    • getZoneId

      @Nullable ZoneId getZoneId()
      Returns:
      The time zone of the given getRange(), and also the zime zone in which the free slots are returned. May be null, in which case the default time zone of the AppointmentTemplate is used.

    • isIncludePastAppointments

      boolean isIncludePastAppointments()
      Returns:
      If true, includes all appointments in the given month, even if they lie in the past.