de.xima.fc.form.common.interfaces

Interface IFD2AppointmentProvider

All Superinterfaces:

Serializable

All Known Implementing Classes:

DefaultFD2AppointmentProvider

public interface IFD2AppointmentProvider
extends Serializable

Provider for accessing appointments and appointment templates when a form is rendered.

Author:

XIMA MEDIA GmbH

Method Summary

Modifier and Type	Method and Description
com.alibaba.fastjson.JSONArray	createAppointmentTemplateJSON() Returns a list of all available appointment templates.
IAppointmentData	getAppointmentData(String appointmentUuid)
boolean	validateSubmittedAppointment(IXGlobalValidationParams params) Validates the submitted appointments, checking whether they may be created, moved, or deleted.

Method Detail

createAppointmentTemplateJSON

com.alibaba.fastjson.JSONArray createAppointmentTemplateJSON()

Returns a list of all available appointment templates. This is used in the designer to show the list of available templates when the appointment form item is configured.

• id: (string) The database ID of the appointment template
• name: (string) The name of the appointment template.
• maximumAdvanceBooking: (number) How many weeks in advance an appointment may be booked.
• minimumBookingNotice: (number) How many hours must lie before slot so that it may be booked.
• uuid: (string) The UUID of the appointment template

Parameters:

clientId - ID of the client for which to create the appointment template data.

Returns:

A list of all available appointment templates.

getAppointmentData

IAppointmentData getAppointmentData(String appointmentUuid)

Parameters:

appointmentUuid - The UUID of an appointment for which to retrieve its data.

Returns:

The data of the appointment with the given ID.

validateSubmittedAppointment

boolean validateSubmittedAppointment(IXGlobalValidationParams params)

Validates the submitted appointments, checking whether they may be created, moved, or deleted.

Parameters:

params - Appointments to validate.

Returns:

Whether the appointments are valid.