Class AppointmentHandler

java.lang.Object

de.xima.fc.handler.AMSApiHandler

de.xima.fc.handler.entity.GenericHandler

de.xima.fc.handler.entity.AppointmentHandler

All Implemented Interfaces:

IAPIHandler, IAppointmentHandler, IGenericHandler, Serializable

public class AppointmentHandler
extends GenericHandler
implements IAppointmentHandler

Handler implementation for reading and writing Appointment entities.

Author:

XIMA MEDIA GmbH

See Also:

• Serialized Form

Field Summary

Fields inherited from class GenericHandler

LOG

Constructor Summary

Constructors

Constructor	Description
AppointmentHandler()

Method Summary

Modifier and Type	Method	Description
void	cancelBookedAppointment(UserContext uc, IAppointmentDeleteBookingParams params)	Cancels the given appointment.
Appointment	createBookedAppointment(UserContext uc, IAppointmentCreateBookingParams params)	Books the given appointment.
List<Appointment>	getAllBy(UserContext uc, IAppointmentQueryParams params)	Returns all appointments that match the given query parameters.
<View extends IEffectiveAppointmentStatusProviding> List<View>	getAttributesBy(UserContext uc, IAppointmentQueryParams params, Class<View> viewClass)	Returns all the attributes of the appointments specified by the IAppointmentQueryParams.
Appointment	getBy(UserContext uc, de.xima.cmn.criteria.QueryCriteriaManager qcm, boolean eager)	Finds the appointment with the QueryCriteriaManager and an is able to load it eagerly.
Appointment	getByUUID(UserContext uc, String uuid)	Finds the appointment with the given UUID.
Appointment	getByUUID(UserContext uc, String uuid, boolean eager)	Finds the appointment with the given UUID and an is able to load it eagerly.
Appointment	getByUUID(UserContext uc, UUID uuid)	Finds the appointment with the given UUID.
Appointment	moveBookedAppointment(UserContext uc, IAppointmentMoveBookingParams params)	Moves an appointment to a different time and date.
List<EAppointmentBookingError>	validateAppointments(UserContext uc, IAppointmentValidateParams params)	Validates whether the given appointments can be created or updated.

Methods inherited from class 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 AMSApiHandler

getName

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface IAPIHandler

getName

Methods inherited from interface IGenericHandler

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

Constructor Details

AppointmentHandler

public AppointmentHandler()

Method Details

cancelBookedAppointment

public void cancelBookedAppointment(UserContext uc,
 IAppointmentDeleteBookingParams params)
                             throws AppointmentBookingException

Description copied from interface: IAppointmentHandler

Cancels the given appointment. You should call IAppointmentHandler.validateAppointments(UserContext, IAppointmentValidateParams) first if you have not done so yet.

Specified by:

cancelBookedAppointment in interface IAppointmentHandler

Parameters:

uc - Current user context for accessing the database.

params - Parameters with the appointment to cancel, must be a persisted entity.

Throws:

AppointmentBookingException - When the booking could not be performed. See AppointmentBookingException.getBookingError() for more details.

createBookedAppointment

public Appointment createBookedAppointment(UserContext uc,
 IAppointmentCreateBookingParams params)
                                    throws AppointmentBookingException

Description copied from interface: IAppointmentHandler

Books the given appointment. You should call IAppointmentHandler.validateAppointments(UserContext, IAppointmentValidateParams) first if you have not done so yet.

Specified by:

createBookedAppointment in interface IAppointmentHandler

Parameters:

uc - Current user context for accessing the database.

params - Parameters with the appointment to book, must be a new (non-persisted) entity.

Returns:

The persisted appointment.

Throws:

AppointmentBookingException - When the booking could not be performed. See AppointmentBookingException.getBookingError() for more details.

getAllBy

public List<Appointment> getAllBy(UserContext uc,
 IAppointmentQueryParams params)

Description copied from interface: IAppointmentHandler

Returns all appointments that match the given query parameters. You should call IAppointmentHandler.validateAppointments(UserContext, IAppointmentValidateParams) first if you have not done so yet.

Specified by:

getAllBy in interface IAppointmentHandler

Parameters:

uc - Current user context for accessing the database.

params - Restrictions to apply the returned appointments.

Returns:

All appointments that match the given query parameters.

getAttributesBy

public <View extends IEffectiveAppointmentStatusProviding>
List<View> getAttributesBy(UserContext uc,
 IAppointmentQueryParams params,
 Class<View> viewClass)

Description copied from interface: IAppointmentHandler

Returns all the attributes of the appointments specified by the IAppointmentQueryParams.

Specified by:

getAttributesBy in interface IAppointmentHandler

Parameters:

uc - User context for the database transaction.

params - the appointment query params

viewClass - the class of the IEffectiveAppointmentStatusProviding implementation

Returns:

the attributes specified by the appointment query params

getByUUID

public Appointment getByUUID(UserContext uc,
 String uuid)

Description copied from interface: IAppointmentHandler

Finds the appointment with the given UUID.

Specified by:

getByUUID in interface IAppointmentHandler

Parameters:

uc - Current user context for accessing the database.

uuid - UUID of an appointment.

Returns:

The appointment with the given UUID.

getByUUID

public Appointment getByUUID(UserContext uc,
 String uuid,
 boolean eager)

Description copied from interface: IAppointmentHandler

Finds the appointment with the given UUID and an is able to load it eagerly.

Specified by:

getByUUID in interface IAppointmentHandler

Parameters:

uc - Current user context for accessing the database.

uuid - UUID of an appointment.

eager - the flag to load the appointment eagerly.

Returns:

The appointment with the given UUID.

getBy

public Appointment getBy(UserContext uc,
 de.xima.cmn.criteria.QueryCriteriaManager qcm,
 boolean eager)

Description copied from interface: IAppointmentHandler

Finds the appointment with the QueryCriteriaManager and an is able to load it eagerly.

Specified by:

getBy in interface IAppointmentHandler

Parameters:

uc - Current user context for accessing the database.

qcm - Custom filter criteria for the appointment.

eager - the flag to load the appointment eagerly.

Returns:

The appointment with the given UUID.

getByUUID

public Appointment getByUUID(UserContext uc,
 UUID uuid)

Description copied from interface: IAppointmentHandler

Finds the appointment with the given UUID.

Specified by:

getByUUID in interface IAppointmentHandler

Parameters:

uc - Current user context for accessing the database.

uuid - UUID of an appointment.

Returns:

The appointment with the given UUID.

moveBookedAppointment

public Appointment moveBookedAppointment(UserContext uc,
 IAppointmentMoveBookingParams params)
                                  throws AppointmentBookingException

Description copied from interface: IAppointmentHandler

Moves an appointment to a different time and date.

Specified by:

moveBookedAppointment in interface IAppointmentHandler

Parameters:

uc - Current user context for accessing the database.

params - Parameters with the appointment to move.

Returns:

The updated appointment from the database.

Throws:

AppointmentBookingException - When the booking could not be performed. See AppointmentBookingException.getBookingError() for more details.

validateAppointments

public List<EAppointmentBookingError> validateAppointments(UserContext uc,
 IAppointmentValidateParams params)

Description copied from interface: IAppointmentHandler

Validates whether the given appointments can be created or updated.

Specified by:

validateAppointments in interface IAppointmentHandler

Parameters:

uc - Current user context for accessing the database.

params - Parameters with the appointments to validate.

Returns:

The validation errors for each appointment.