Package de.xima.fc.servlet.parameter

Class AppointmentFreeSlotsServletParameter

java.lang.Object
de.xima.fc.servlet.parameter.AServletParameter
de.xima.fc.servlet.parameter.AppointmentFreeSlotsServletParameter
All Implemented Interfaces:
Serializable
public class AppointmentFreeSlotsServletParameter extends AServletParameter implements Serializable
Represents the parsed parameters of a request to the AppointmentFreeSlotsServlet.
Since:
6.5.0
Author:
XIMA MEDIA GmbH
See Also:

  • Method Details

    • getAppointmentTemplateUuid

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

    • getMonth

      public Month getMonth()
      Returns:
      The month for which to find free slots.

    • getYear

      public int getYear()
      Returns:
      The year for which to find free slots.

    • isIncludePastAppointments

      public boolean isIncludePastAppointments()
      Returns:
      Whether appointments that lie in the past (relative to the server time) are included.

    • getZoneId

      public ZoneId getZoneId()
      Returns:
      The zone ID for the returned free slots. May be null for the default time zone.

    • toQueryParams

      public IAppointmentFreeSlotQueryParams toQueryParams(long clientId)
      Converts these servlet parameters to the appropriate parameters required by the free slot query API.
      Parameters:
      clientId - ID of the current client.
      Returns:
      The parameters that can be passed to the free slot query executor or API method.

    • toString

      public String toString()
      Overrides:
      toString in class AServletParameter

    • parse

      public static AppointmentFreeSlotsServletParameter parse(javax.servlet.http.HttpServletRequest request) throws IOException
      Given an HTTP request of an appointment free slot servlet, parses and validates the parameters.
      Parameters:
      request - The HTTP request to the appointment free slot servlet.
      Returns:
      The parsed servlet parameters.
      Throws:
      IOException - When the request data could not be read.
      IllegalArgumentException - When the parameters are invalid.