Package de.xima.fc.handler.interfaces.entity

Interface IAppointmentTemplateHandler

All Superinterfaces:

IAPIHandler, IGenericHandler, Serializable

All Known Implementing Classes:

AppointmentTemplateHandler

public interface IAppointmentTemplateHandler
extends IGenericHandler

Handler for AppointmentTemplate entities.

Since:

6.5.0

Author:

XIMA MEDIA GmbH

Method Summary

Modifier and Type	Method	Description
IAppointmentFreeSlotQueryResult	executeFreeSlotQuery(UserContext uc, IAppointmentFreeSlotQueryParams params)	Finds all available date slots for the given appointment template, in the given month of the year.
IAppointmentIcalQueryResult	executeIcalQuery(UserContext uc, IAppointmentIcalQueryParams params)	Finds all available appointments for the given appointment template, and returns and iCal file.
List<AppointmentTemplate>	getAllByClient(UserContext uc, Mandant currentClient)	Finds all available appointment templates of the given client.
AppointmentTemplate	getByUUID(UserContext uc, Mandant client, String uuid)	Finds the appointment template with the given UUID.
AppointmentTemplate	getByUUID(UserContext uc, Mandant client, UUID uuid)	Finds the appointment template with the given UUID.

Methods inherited from interface de.xima.fc.com.interfaces.IAPIHandler

getName

Methods inherited from interface de.xima.fc.handler.interfaces.entity.IGenericHandler

create, create, delete, delete, deleteBy, deleteById, deleteById, getAll, getAllBy, getAttributes, getAttributes, getBy, getById, getById, getById, getEntityRefs, getSingleAttributes, getSingleAttributes, resultTotalCount, update, update

Method Details

executeFreeSlotQuery

IAppointmentFreeSlotQueryResult executeFreeSlotQuery(UserContext uc,
 IAppointmentFreeSlotQueryParams params)

Finds all available date slots for the given appointment template, in the given month of the year.

Parameters:

uc - Current user context.

params - Parameters for the appointment query.

Returns:

All free, available slots for the given parameters.

executeIcalQuery

IAppointmentIcalQueryResult executeIcalQuery(UserContext uc,
 IAppointmentIcalQueryParams params)
                                      throws AppointmentIcalException

Finds all available appointments for the given appointment template, and returns and iCal file.

Parameters:

uc - Current user context.

params - Parameters for the appointment iCal query.

Returns:

An iCal file with the appointments.

Throws:

AppointmentIcalException - When the query could not be executed.

getAllByClient

List<AppointmentTemplate> getAllByClient(UserContext uc,
 Mandant currentClient)

Finds all available appointment templates of the given client.

Parameters:

uc - Current user context.

currentClient - Client for which to retrieve appointments.

Returns:

All appointment templates of the given client.

getByUUID

AppointmentTemplate getByUUID(UserContext uc,
 Mandant client,
 String uuid)

Finds the appointment template with the given UUID.

Parameters:

uc - Current user context for accessing the database.

client - The client for which to find the templates.

uuid - UUID of an appointment.

Returns:

The appointment with the given UUID.

getByUUID

AppointmentTemplate getByUUID(UserContext uc,
 Mandant client,
 UUID uuid)

Finds the appointment template with the given UUID.

Parameters:

uc - Current user context for accessing the database.

client - The client for which to find the templates.

uuid - UUID of an appointment.

Returns:

The appointment with the given UUID.