Package de.xima.fc.api.entity
Class AppointmentTemplateAPI
- java.lang.Object
-
- de.xima.fc.api.ASubAPI
-
- de.xima.fc.api.entity.AEntityAPI<AppointmentTemplate>
-
- de.xima.fc.api.entity.AppointmentTemplateAPI
-
public class AppointmentTemplateAPI extends AEntityAPI<AppointmentTemplate>
API class for reading and writingAppointmentTemplate
entities.- Since:
- 6.5.0
- Author:
- XIMA AppointmentTemplate
-
-
Field Summary
-
Fields inherited from class de.xima.fc.api.entity.AEntityAPI
entityClass
-
-
Constructor Summary
Constructors Constructor Description AppointmentTemplateAPI()
-
Method Summary
All Methods Instance Methods Concrete Methods 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 class de.xima.fc.api.entity.AEntityAPI
create, create, delete, delete, deleteAllBy, deleteById, deleteById, getAll, getAllBy, getAttributes, getAttributes, getBy, getById, getById, getSingleAttributes, getSingleAttributes, resultTotalCount, resultTotalCount, update, update
-
Methods inherited from class de.xima.fc.api.ASubAPI
getHandlerProvider
-
-
-
-
Method Detail
-
executeFreeSlotQuery
public 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
public 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
public List<AppointmentTemplate> getAllByClient(UserContext uc, Mandant currentClient)
Finds all available appointment templates of the given client.- Parameters:
uc
- Current user context.currentClient
- The client for which to find the appointments.- Returns:
- All appointment templates of the given client.
-
getByUUID
public 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
public 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.
-
-