Package de.xima.fc.appointment

Class IcalQueryExecutor<Context>

java.lang.Object

de.xima.fc.appointment.IcalQueryExecutor<Context>

Type Parameters:

Context - Context for the access object, such as a database session etc.

public class IcalQueryExecutor<Context>
extends Object

Executor with the logic for creating iCal files with appointments.

Since:

6.5.0

Author:

XIMA MEDIA GmbH

Constructor Summary

Constructors

Constructor	Description
IcalQueryExecutor(IAppointmentIcalQueryAccessObject<Context> accessObject)	Creates a new executor for creating iCal with with appointments.

Method Summary

Modifier and Type	Method	Description
IAppointmentIcalQueryResult	executeQuery(Context ctx, IAppointmentIcalQueryParams params, Instant now)	Performs an iCal query and returns an iCal file.
IAppointmentIcalQueryResult	executeQuery(Locale locale, AppointmentTemplate template, List<Appointment> appointments, String sourceUrl)	Creates an iCal file from the given appointments.

Methods inherited from class java.lang.Object

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

Constructor Detail

IcalQueryExecutor

public IcalQueryExecutor(IAppointmentIcalQueryAccessObject<Context> accessObject)

Creates a new executor for creating iCal with with appointments.

Parameters:

accessObject - Object for accessing the database.

Method Detail

executeQuery

public IAppointmentIcalQueryResult executeQuery(Context ctx,
                                                IAppointmentIcalQueryParams params,
                                                Instant now)
                                         throws AppointmentIcalException

Performs an iCal query and returns an iCal file.

Parameters:

ctx - Context for the access object.

params - Parameters for the iCal query.

now - The current server time.

Returns:

The resulting iCal file.

Throws:

AppointmentIcalException - When the appointments cold not be loaded.

executeQuery

public IAppointmentIcalQueryResult executeQuery(Locale locale,
                                                AppointmentTemplate template,
                                                List<Appointment> appointments,
                                                String sourceUrl)
                                         throws AppointmentIcalException

Creates an iCal file from the given appointments.

Parameters:

locale - Locale to use for localized messages (description etc.)

template - Template to which the appointments belong.

appointments - Appointments to include in the iCal file.

sourceUrl - URL that is echoed back as the source of the iCal file.

Returns:

The generated iCal file.

Throws:

AppointmentIcalException - When the iCal file could not be created, such as due to a database error.