Package de.uplanet.lucy.server.auxiliaries.control.calendar

Class VCAppointmentHelper

  • @VelocityCallable("instance")
public final class VCAppointmentHelper
extends Object

    • Constructor Detail

      • VCAppointmentHelper

        public VCAppointmentHelper()
        Default constructor.

      • VCAppointmentHelper

        @ForUnitTesting
public VCAppointmentHelper​(de.uplanet.lucy.server.calendar.businesslogic.ICalendarEngineFactory l_engineFactory)

    • Method Detail

      • getAppointmentsPerDay

        public Map<CalendarAwareDate,​List<de.uplanet.lucy.server.businesslogic.control.calendar.IVCControlAppointment>> getAppointmentsPerDay​(List<de.uplanet.lucy.server.businesslogic.control.calendar.IVCControlAppointment> p_appointments,
                                                                                                                                            TimeZone p_tz)
        Get all appointments per day. Note that it takes the first appointment from the list and its start date for the first day. Likewise the end-date is derived from the to-date of the last appointment from the given list. If that's not the desired behavior the method on the calendar control should be used.
        Parameters:
        p_appointments - The appointments to group.
        p_tz - The time zone of the user.
        Returns:
        A map, mapping appointments to each day.

      • filterAppointmentsByDate

        public List<de.uplanet.lucy.server.businesslogic.control.calendar.IVCControlAppointment> filterAppointmentsByDate​(List<de.uplanet.lucy.server.businesslogic.control.calendar.IVCControlAppointment> p_appointments,
                                                                                                                  CalendarAwareDate p_from,
                                                                                                                  CalendarAwareDate p_to)
        Filter appointments by date-range.
        Parameters:
        p_appointments - The appointments to filter.
        p_from - The from-date.
        p_to - The to-date.
        Returns:
        The filtered appointments.

      • getCalendarControlInfoByPageGuid

        public de.uplanet.lucy.server.auxiliaries.control.calendar.IVCCalendarControlInfo getCalendarControlInfoByPageGuid​(String p_strGuid)
        Get the calendar control information reference.
        Parameters:
        p_strGuid - The GUID of the page.
        Returns:
        The calendar control information reference or null if it's not found.

      • getCalendarControlInfoByControlGuid

        public de.uplanet.lucy.server.auxiliaries.control.calendar.IVCCalendarControlInfo getCalendarControlInfoByControlGuid​(String p_strGuid)
        Get the calendar control information reference.
        Parameters:
        p_strGuid - The GUID of the calendar control info instance.
        Returns:
        The calendar control information reference or null if it's not found.

      • getGroupListItems

        public List<de.uplanet.lucy.server.businesslogic.control.calendar.IVCControlListItem> getGroupListItems​(List<de.uplanet.lucy.server.businesslogic.control.calendar.IVCControlAppointmentGroupEntry> p_groupEntries)
        Merges group entries with the same grouping value. The group entries list must be sorted by grouping value.
        Parameters:
        p_groupEntries - The group entries.
        Returns:
        Merged group entries in a tree item.

      • getAppointment

        public de.uplanet.lucy.server.businesslogic.control.calendar.IVCControlAppointment getAppointment​(de.uplanet.lucy.server.IProcessingContext p_ctx,
                                                                                                  String p_strRecId,
                                                                                                  String p_strPluginGuid,
                                                                                                  VCCalendarControlInfo p_calCtrlInfo)
        Get an appointment.
        Parameters:
        p_ctx - The processing context.
        p_strRecId - The record ID.
        p_strPluginGuid - The plugin GUID.
        p_calCtrlInfo - The calendar control information object.
        Returns:
        An appointment denoted by the record ID / plugin GUID.

      • isRecurringAppointment

        public boolean isRecurringAppointment​(de.uplanet.lucy.server.IProcessingContext p_ctx,
                                      String p_strDgGuid,
                                      String p_strRecId)
        Determines if a record / appointment is a recurrence type (exceptions are handled as if no recurrence type is given.
        Parameters:
        p_ctx - The processing context.
        p_strDgGuid - The data group GUID.
        p_strRecId - The record ID.
        Returns:
        true if the record / appointment is a regular recurrence type.