Package de.xima.fc.appointment

Class AppointmentQueryParams

java.lang.Object

de.xima.fc.appointment.AppointmentQueryParams

All Implemented Interfaces:

IAppointmentQueryParams, Serializable

public class AppointmentQueryParams
extends Object
implements IAppointmentQueryParams

POJO implementation with builder for IAppointmentQueryParams.

Since:

6.5.0

Author:

XIMA MEDIA GmbH

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AppointmentQueryParams.Builder	A builder for IAppointmentQueryParams.

Method Summary

Modifier and Type	Method	Description
static AppointmentQueryParams.Builder	builder()
static AppointmentQueryParams.Builder	builder(Mandant client)
static AppointmentQueryParams.Builder	builder(Vorgang formRecord)
Iterable<AppointmentTemplate>	getAppointmentTemplates()
Mandant	getClient()
Iterable<Long>	getExcludedAppointmentIds()
Iterable<de.xima.cmn.criteria.FilterCriterion>	getFilterCriteria()	Extends the query with filter criterions.
Iterable<Vorgang>	getFormRecords()
Integer	getPage()
Integer	getPageSize()
com.google.common.collect.Range<Instant>	getRange()
Iterable<de.xima.cmn.criteria.SelectCriterion>	getSelectCriteria()	Applies only when used for a select attribute query.
ESortingOrder	getSortingOrder()
Iterable<EAppointmentStatus>	getStatus()
boolean	isIncludePartiallyInRange()
boolean	isInitFormRecord()

Methods inherited from class java.lang.Object

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

Method Detail

getAppointmentTemplates

public Iterable<AppointmentTemplate> getAppointmentTemplates()

Specified by:

getAppointmentTemplates in interface IAppointmentQueryParams

Returns:

A list of appointment templates to which the appointments must belong. If null or empty, no restriction is applied.

getClient

public Mandant getClient()

Specified by:

getClient in interface IAppointmentQueryParams

Returns:

The client to which the appointments must belong.

getExcludedAppointmentIds

public Iterable<Long> getExcludedAppointmentIds()

Specified by:

getExcludedAppointmentIds in interface IAppointmentQueryParams

Returns:

A list of appointments IDs to exclude in the result. If null or empty, no restriction is applied.

getFormRecords

public Iterable<Vorgang> getFormRecords()

Specified by:

getFormRecords in interface IAppointmentQueryParams

Returns:

A list form records to which the returned appointments must belong. If null or empty, no restriction is applied.

getRange

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

Specified by:

getRange in interface IAppointmentQueryParams

Returns:

The time range of appointments to include. Appointments outside this range are excluded in the result.

getSelectCriteria

public Iterable<de.xima.cmn.criteria.SelectCriterion> getSelectCriteria()

Description copied from interface: IAppointmentQueryParams

Applies only when used for a select attribute query.

Specified by:

getSelectCriteria in interface IAppointmentQueryParams

Returns:

A list of fields (columns) to include in the result.

getStatus

public Iterable<EAppointmentStatus> getStatus()

Specified by:

getStatus in interface IAppointmentQueryParams

Returns:

A list of status the appointments must have. If null or empty, no restriction is applied.

isIncludePartiallyInRange

public boolean isIncludePartiallyInRange()

Specified by:

isIncludePartiallyInRange in interface IAppointmentQueryParams

Returns:

Applies only if IAppointmentQueryParams.getRange() is set. If false, only appointments that fall completely within the given range are included in the result. Otherwise, appointments that only overlap partially are included as well.

builder

public static AppointmentQueryParams.Builder builder()

Returns:

A new, empty builder.

builder

public static AppointmentQueryParams.Builder builder(Mandant client)

Parameters:

client - The client to which to restrict the appointments.

Returns:

A builder for query params for appointments with the given client.

builder

public static AppointmentQueryParams.Builder builder(Vorgang formRecord)

Parameters:

formRecord - The form record to which to restrict the appointments.

Returns:

A builder for query params for appointments with the given form record.

isInitFormRecord

public boolean isInitFormRecord()

Specified by:

isInitFormRecord in interface IAppointmentQueryParams

Returns:

Applies only when loading data via the API provider (ignored otherwise). true to load the form record (@code Appointment.getFormRecord()) eagerly, false to load it lazily. Defaults to false.

getSortingOrder

public ESortingOrder getSortingOrder()

Specified by:

getSortingOrder in interface IAppointmentQueryParams

Returns:

Returns the order in which the dates will be sorted.

getFilterCriteria

public Iterable<de.xima.cmn.criteria.FilterCriterion> getFilterCriteria()

Description copied from interface: IAppointmentQueryParams

Extends the query with filter criterions.

Specified by:

getFilterCriteria in interface IAppointmentQueryParams

Returns:

A list of fields (columns) to include in the result.

getPage

public Integer getPage()

Specified by:

getPage in interface IAppointmentQueryParams

Returns:

The page number relevant for paging.

getPageSize

public Integer getPageSize()

Specified by:

getPageSize in interface IAppointmentQueryParams

Returns:

The number off values of a page.