Package de.xima.fc.handler.entity
Class AppointmentTemplateHandler
- java.lang.Object
-
- de.xima.fc.handler.AMSApiHandler
-
- de.xima.fc.handler.entity.GenericHandler
-
- de.xima.fc.handler.entity.AppointmentTemplateHandler
-
- All Implemented Interfaces:
IAPIHandler
,IAppointmentTemplateHandler
,IGenericHandler
,Serializable
public class AppointmentTemplateHandler extends GenericHandler implements IAppointmentTemplateHandler
Handler implementation for reading and writingAppointmentTemplate
entities.- Author:
- XIMA MEDIA GmbH
- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from class de.xima.fc.handler.entity.GenericHandler
LOG
-
-
Constructor Summary
Constructors Constructor Description AppointmentTemplateHandler()
-
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.handler.entity.GenericHandler
create, create, delete, delete, deleteBy, deleteById, deleteById, getAll, getAllBy, getAttributes, getAttributes, getBy, getById, getById, getById, getEntityRefs, getSingleAttributes, getSingleAttributes, resultTotalCount, serializableList, update, update
-
Methods inherited from class de.xima.fc.handler.AMSApiHandler
getName
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
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 Detail
-
executeFreeSlotQuery
public IAppointmentFreeSlotQueryResult executeFreeSlotQuery(UserContext uc, IAppointmentFreeSlotQueryParams params)
Description copied from interface:IAppointmentTemplateHandler
Finds all available date slots for the given appointment template, in the given month of the year.- Specified by:
executeFreeSlotQuery
in interfaceIAppointmentTemplateHandler
- 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
Description copied from interface:IAppointmentTemplateHandler
Finds all available appointments for the given appointment template, and returns and iCal file.- Specified by:
executeIcalQuery
in interfaceIAppointmentTemplateHandler
- 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)
Description copied from interface:IAppointmentTemplateHandler
Finds all available appointment templates of the given client.- Specified by:
getAllByClient
in interfaceIAppointmentTemplateHandler
- Parameters:
uc
- Current user context.currentClient
- Client for which to retrieve appointments.- Returns:
- All appointment templates of the given client.
-
getByUUID
public AppointmentTemplate getByUUID(UserContext uc, Mandant client, String uuid)
Description copied from interface:IAppointmentTemplateHandler
Finds the appointment template with the given UUID.- Specified by:
getByUUID
in interfaceIAppointmentTemplateHandler
- 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)
Description copied from interface:IAppointmentTemplateHandler
Finds the appointment template with the given UUID.- Specified by:
getByUUID
in interfaceIAppointmentTemplateHandler
- 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.
-
-