Package de.xima.fc.interfaces.appointment

Interface IAppointmentQueryParams

  • All Superinterfaces:
    Serializable
    All Known Implementing Classes:
    AppointmentQueryParams
    public interface IAppointmentQueryParams
extends Serializable
    Parameters for the appointment DAO for querying existing appointments.
    Since:
    6.5.0
    Author:
    XIMA MEDIA GmbH

    • Method Detail

      • getAppointmentTemplates

        Iterable<AppointmentTemplate> getAppointmentTemplates()
        Returns:
        A list of appointment templates to which the appointments must belong. If null or empty, no restriction is applied.

      • isInitFormRecord

        boolean isInitFormRecord()
        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.

      • getClient

        Mandant getClient()
        Returns:
        The client to which the appointments must belong.

      • getExcludedAppointmentIds

        Iterable<Long> getExcludedAppointmentIds()
        Returns:
        A list of appointments IDs to exclude in the result. If null or empty, no restriction is applied.

      • getFormRecords

        Iterable<Vorgang> getFormRecords()
        Returns:
        A list form records to which the returned appointments must belong. If null or empty, no restriction is applied.

      • getRange

        com.google.common.collect.Range<Instant> getRange()
        Returns:
        The time range of appointments to include. Appointments outside this range are excluded in the result.

      • getSelectCriteria

        Iterable<de.xima.cmn.criteria.SelectCriterion> getSelectCriteria()
        Applies only when used for a select attribute query.
        Returns:
        A list of fields (columns) to include in the result.

      • getFilterCriteria

        Iterable<de.xima.cmn.criteria.FilterCriterion> getFilterCriteria()
        Extends the query with filter criterions.
        Returns:
        A list of fields (columns) to include in the result.

      • getStatus

        Iterable<EAppointmentStatus> getStatus()
        Returns:
        A list of status the appointments must have. If null or empty, no restriction is applied.

      • isIncludePartiallyInRange

        boolean isIncludePartiallyInRange()
        Returns:
        Applies only if 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.

      • getSortingOrder

        ESortingOrder getSortingOrder()
        Returns:
        Returns the order in which the dates will be sorted.

      • getPage

        Integer getPage()
        Returns:
        The page number relevant for paging.

      • getPageSize

        Integer getPageSize()
        Returns:
        The number off values of a page.