de.xima.fc.interfaces.appointment

Interface IAppointmentIcalQueryParams

All Superinterfaces:

Serializable

public interface IAppointmentIcalQueryParams
extends Serializable

The parameters for a query that retrieves the available appointments of a AppointmentTemplate as an iCal file. Used by the iCal servlet.

Since:

6.5.0

Author:

XIMA MEDIA GmbH

Method Summary

Modifier and Type	Method and Description
UUID	getAppointmentTemplateUuid()
UUID	getClientUuid()
Locale	getLocale()
com.google.common.collect.Range<Instant>	getRange()
String	getSourceUrl()
boolean	isIncludePastAppointments()

Method Detail

getAppointmentTemplateUuid

UUID getAppointmentTemplateUuid()

Returns:

The appointment template for which to find the booked appointments.

getClientUuid

UUID getClientUuid()

Returns:

The client who owns the appointment template for which to find the booked appointments.

getLocale

Locale getLocale()

Returns:

Locale to use for localized messages (description etc.)

getRange

com.google.common.collect.Range<Instant> getRange()

Returns:

The temporal range where to find appointments.

getSourceUrl

String getSourceUrl()

Returns:

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

isIncludePastAppointments

boolean isIncludePastAppointments()

Returns:

If true, includes appointments even if they lie in the past.