Package de.xima.fc.servlet.parameter

Class AppointmentIcalServletParameter

java.lang.Object

de.xima.fc.servlet.parameter.AServletParameter

de.xima.fc.servlet.parameter.AppointmentIcalServletParameter

All Implemented Interfaces:

Serializable

public class AppointmentIcalServletParameter
extends AServletParameter
implements Serializable

Represents the parameters of the AppointmentIcalServlet. Also offers a static constructor method for parsing the parameters.

Since:

6.5.0

Author:

XIMA MEDIA GmbH

See Also:

Serialized Form

Method Summary

Modifier and Type	Method	Description
UUID	getAppointmentTemplateUuid()
UUID	getClientUuid()
Locale	getLocale()
com.google.common.collect.Range<Instant>	getRange()
String	getSourceUrl()
boolean	isIncludePastAppointments()
static AppointmentIcalServletParameter	parse(javax.servlet.http.HttpServletRequest request)	Parses the parameters passed to the AppointmentIcalServlet and returns the result.
IAppointmentIcalQueryParams	toQueryParams()
String	toString()

Methods inherited from class de.xima.fc.servlet.parameter.AServletParameter

getBoolean, getBoolean, getEnum, getEnum, getInteger, getInteger, getLocalDateTime, getLocalDateTime, getLocale, getLong, getLong, getPathPart, getString, getString, getUuid, getUuid, getZoneId, toBoolean, toEnum, toInteger, toLocalDateTime, toLocale, toLong, toString, toUuid, toZoneId

Methods inherited from class java.lang.Object

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

Method Detail

getAppointmentTemplateUuid

public UUID getAppointmentTemplateUuid()

Returns:

The UUID of the AppointmentTemplate for which an iCal file should be created.

getClientUuid

public UUID getClientUuid()

Returns:

The UUID of a client who owns the getAppointmentTemplateUuid().

getLocale

public Locale getLocale()

Returns:

The locale to use for localized messages etc.

getRange

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

Returns:

The range of appointments to include in the returned iCal file.

getSourceUrl

public String getSourceUrl()

isIncludePastAppointments

public boolean isIncludePastAppointments()

Returns:

Whether appointment in the past should be included.

toQueryParams

public IAppointmentIcalQueryParams toQueryParams()

Returns:

Converts these servlet parameters to the corresponding IAppointmentIcalQueryParams.

toString

public String toString()

Overrides:

toString in class AServletParameter

parse

public static AppointmentIcalServletParameter parse(javax.servlet.http.HttpServletRequest request)
                                             throws IllegalArgumentException

Parses the parameters passed to the AppointmentIcalServlet and returns the result.

Parameters:

request - the HttpServletRequest

Returns:

The parsed parameters.

Throws:

IllegalArgumentException - When the parameters are invalid.