Package de.xima.fc.entities

Class AppointmentTemplate

java.lang.Object
de.xima.cmn.dao.model.AEntity<Long>
de.xima.fc.entities.AbstractEntity
de.xima.fc.entities.AbstractLockableEntity
de.xima.fc.entities.AppointmentTemplate
All Implemented Interfaces:
de.xima.cmn.dao.interfaces.IEntity<Long>, de.xima.cmn.dao.interfaces.ILockableEntity<Long>, IDescriptionProviding, ILockingVersionProviding, IMandantDependent, INameProviding, ITransferable, ITransferableEntity, ITransferableLockableEntity, IUUIDEntity, Serializable, Comparable<de.xima.cmn.dao.interfaces.IEntity<Long>>
@Entity public class AppointmentTemplate extends AbstractLockableEntity implements INameProviding, IDescriptionProviding, IUUIDEntity, IMandantDependent
An entity for the appointment module of formcycle. Describes a template with the configuration of the appointments that can be made.
Since:
6.5.0
Author:
XIMA MEDIA GmbH
See Also:

  • Field Details

  • Constructor Details

    • AppointmentTemplate

      public AppointmentTemplate()

  • Method Details

    • addClosingTime

      public void addClosingTime(AppointmentClosingTime closingTime)
      Adds a closing time to this template. Use this in favor of adding to the getClosingTimes() directly, as this sets cross references properly. An appointment slot describes a time range when no appointments can be booked.
      Parameters:
      closingTime - A closing time to add.

    • addClosingTimes

      public void addClosingTimes(Iterable<AppointmentClosingTime> closingTimes)
      Adds one or more closing times to this template. Use this in favor of adding to the getClosingTimes() directly, as this sets cross references properly. An appointment slot describes a time range when no appointments can be booked.
      Parameters:
      closingTimes - A sequence of closing times to add.

    • addSlot

      public void addSlot(AppointmentSlot slot)
      Adds a slot to this template. Use this in favor of adding to the getSlots() directly, as this sets cross references properly. Each available slot is a time range where appointments can be booked.
      Parameters:
      slot - A slot to add.

    • addSlots

      public void addSlots(Iterable<AppointmentSlot> slots)
      Adds one ore more slots to this template. Use this in favor of adding to the getSlots() directly, as this sets cross references properly. Each available slot is a time range where appointments can be booked.
      Parameters:
      slots - A sequence of slots to add.

    • addType

      public void addType(AppointmentType type)
      Adds a type to this template. Use this in favor of adding to the getAppointmentTypes() directly, as this sets cross references properly. An appointment type describes an activity for which an appointment can be booked, such as drying hairs or dying hairs.
      Parameters:
      type - A type to add.

    • getAppointmentTypes

      public List<AppointmentType> getAppointmentTypes()
      Returns:
      A list of the appointment types of this template. An appointment type describes an activity for which an appointment can be booked, such as drying hairs or dying hairs.

    • getBeschreibung

      @Deprecated public String getBeschreibung()
      Deprecated.
      Use getDescription()
      Specified by:
      getBeschreibung in interface IDescriptionProviding
      Returns:
      The internal description of this entity that is visible in the backend.

    • getCapacity

      public int getCapacity()
      Returns:
      The capacity of this template. The capacity indicates how many appointments can be booked at the same time.

    • getClient

      public Mandant getClient()
      Returns:
      The client to which this template belongs to.

    • getClosingTimes

      public List<AppointmentClosingTime> getClosingTimes()
      Returns:
      A list of times when no appointments can be booked.

    • getColor

      @Nullable public String getColor()
      Returns:
      The CSS color of this calendar. May be null or empty when no color was set.

    • getDescription

      public String getDescription()
      Specified by:
      getDescription in interface IDescriptionProviding
      Returns:
      The internal description of this entity that is visible in the backend.

    • getHtmlDescriptionTemplate

      public String getHtmlDescriptionTemplate()
      Returns:
      The HTML text of the description for each entry in the generated ICAL file with all appointments.

    • getId

      public Long getId()
      Specified by:
      getId in interface de.xima.cmn.dao.interfaces.IEntity<Long>

    • getMandant

      @Deprecated public Mandant getMandant()
      Deprecated.
      Use getClient().
      Specified by:
      getMandant in interface IMandantDependent
      Returns:
      The client to which this template belongs to.

    • getMaximumAdvanceBooking

      public Duration getMaximumAdvanceBooking()
      Returns:
      How far in advance one can book an appointment, relative to the current date time.

    • getMaximumAdvanceBookingWeeks

      public long getMaximumAdvanceBookingWeeks()
      Returns:
      The value of getMaximumAdvanceBooking(), converted to weeks.

    • getMinimumBookingNotice

      public Duration getMinimumBookingNotice()
      Returns:
      The minumum time that must lie between the current date time and an appointment when a user books it. Can be user to avoid last minute bookings.

    • getMinimumBookingNoticeHours

      public long getMinimumBookingNoticeHours()
      Returns:
      The minumum time in hours that must lie between the current date time and an appointment when a user books it. Can be user to avoid last minute bookings.

    • getMinimumBookingNoticeWeeks

      public long getMinimumBookingNoticeWeeks()
      Returns:
      The minumum time in weeks that must lie between the current date time and an appointment when a user books it. Can be user to avoid last minute bookings.

    • getName

      public String getName()
      Specified by:
      getName in interface INameProviding
      Returns:
      The name of this object.

    • getPlainDescriptionTemplate

      public String getPlainDescriptionTemplate()
      Returns:
      The plain text of the description for each entry in the generated ICAL file with all appointments.

    • getSlots

      public List<AppointmentSlot> getSlots()
      Returns:
      The available slots of this template. Each slot is a time range where appointments can be booked.

    • getSubjectTemplate

      public String getSubjectTemplate()
      Returns:
      The text of the subject for each entry in the generated ICAL file with all appointments.

    • getUUID

      public String getUUID()
      Specified by:
      getUUID in interface IUUIDEntity
      Returns:
      The UUID of this appointment template. Please note that this UUID is guaranteed to be unique only for a given getClient(). That is, two appointment templates belonging to two different clients may have the same UUID.

    • getUUIDObject

      public UUID getUUIDObject()
      Specified by:
      getUUIDObject in interface IUUIDEntity
      Returns:
      The UUID of this appointment template. Please note that this UUID is guaranteed to be unique only for a given getClient(). That is, two appointment templates belonging to two different clients may have the same UUID.

    • getZoneId

      public ZoneId getZoneId()
      Returns:
      Time zone of this appointment template.

    • getZoneIdString

      public String getZoneIdString()
      Returns:
      Time zone of this appointment template.

    • isAllowIcal

      public boolean isAllowIcal()
      Returns:
      Whether to allow viewing the appointments of this template via a HTTP iCal URL.

    • isPrependProcessState

      public boolean isPrependProcessState()
      Returns:
      When true, prepends the state of the corresponding form record to the getSubjectTemplate() in the generated ICAL file.

    • setAllowIcal

      public void setAllowIcal(boolean allowIcal)
      Parameters:
      allowIcal - Whether to allow viewing the appointments of this template via a HTTP iCal URL.

    • setAppointmentTypes

      public void setAppointmentTypes(List<AppointmentType> appointmentTypes)
      Parameters:
      appointmentTypes - A list of the appointment types of this template. An appointment type describes an activity for which an appointment can be booked, such as drying hairs or dying hairs.

    • setBeschreibung

      @Deprecated public void setBeschreibung(String description)
      Deprecated.
      Use setDescription(String).
      Parameters:
      description - The internal description of this entity that is visible in the backend.

    • setCapacity

      public void setCapacity(int capacity)
      Parameters:
      capacity - The capacity of this template. The capacity indicates how many appointments can be booked at the same time.

    • setClient

      public void setClient(Mandant client)
      Parameters:
      client - The client to which this template belongs to.

    • setClosingTimes

      public void setClosingTimes(List<AppointmentClosingTime> closingTimes)
      Parameters:
      closingTimes - A list of times when no appointments can be booked.

    • setColor

      public void setColor(String color)
      Parameters:
      color - The CSS color of this appointment template.

    • setDescription

      public void setDescription(String description)
      Parameters:
      description - The internal description of this entity that is visible in the backend.

    • setHtmlDescriptionTemplate

      public void setHtmlDescriptionTemplate(String htmlDescriptionTemplate)
      Parameters:
      htmlDescriptionTemplate - The HTML text of the description for each entry in the generated ICAL file with all appointments.

    • setMandant

      @Deprecated public void setMandant(Mandant mandant)
      Deprecated.
      Use setClient(Mandant).
      Specified by:
      setMandant in interface IMandantDependent
      Parameters:
      mandant - The client to which this template belongs to.

    • setMaximumAdvanceBooking

      public void setMaximumAdvanceBooking(Duration maximumAdvanceBooking)
      Parameters:
      maximumAdvanceBooking - How far in advance one can book an appointment, relative to the current date time.

    • setMaximumAdvanceBookingWeeks

      public void setMaximumAdvanceBookingWeeks(long maximumAdvanceBookingWeeks)
      Parameters:
      maximumAdvanceBookingWeeks - The new value for getMaximumAdvanceBooking(), in weeks.

    • setMinimumBookingNotice

      public void setMinimumBookingNotice(Duration minimumBookingNotice)
      Parameters:
      minimumBookingNotice - The minumum time that must lie between the current date time and an appointment when a user books it. Can be user to avoid last minute bookings.

    • setMinimumBookingNoticeHours

      public void setMinimumBookingNoticeHours(long minimumBookingNoticeHours)
      Parameters:
      minimumBookingNoticeHours - The minumum time in hours that must lie between the current date time and an appointment when a user books it. Can be user to avoid last minute bookings.

    • setMinimumBookingNoticeWeeks

      public void setMinimumBookingNoticeWeeks(long minimumBookingNoticeWeeks)
      Parameters:
      minimumBookingNoticeWeeks - The minumum time in weeks that must lie between the current date time and an appointment when a user books it. Can be user to avoid last minute bookings.

    • setName

      public void setName(String name)
      Parameters:
      name - The name of this appointment template, as entered in the backend.

    • setPlainDescriptionTemplate

      public void setPlainDescriptionTemplate(String plainDescriptionTemplate)
      Parameters:
      plainDescriptionTemplate - The plain text of the description for each entry in the generated ICAL file with all appointments.

    • setPrependProcessState

      public void setPrependProcessState(boolean prependProcessState)
      Parameters:
      prependProcessState - When true, prepends the state of the corresponding form record to the getSubjectTemplate() in the generated ICAL file.

    • setSlots

      public void setSlots(List<AppointmentSlot> slots)
      Parameters:
      slots - The available slots of this template. Each slot is a time range where appointments can be booked.

    • setSubjectTemplate

      public void setSubjectTemplate(String subjectTemplate)
      Parameters:
      subjectTemplate - The text of the subject for each entry in the generated ICAL file with all appointments.

    • setUUID

      public void setUUID(String uuid)
      Specified by:
      setUUID in interface IUUIDEntity
      Parameters:
      uuid - A new UUID for this appointment template. Please note that this UUID is guaranteed to be unique only for a given getClient(). That is, two appointment templates belonging to two different clients may have the same UUID.

    • setUUIDObject

      public void setUUIDObject(UUID uuid)
      Parameters:
      uuid - A new UUID for this appointment template. Please note that this UUID is guaranteed to be unique only for a given getClient(). That is, two appointment templates belonging to two different clients may have the same UUID.

    • setZoneId

      public void setZoneId(ZoneId zoneId)
      Parameters:
      zoneId - Time zone of this appointment template.

    • setZoneIdString

      public void setZoneIdString(String zoneIdString)
      Parameters:
      zoneIdString - Time zone of this appointment template.