    001package org.cpsolver.studentsct.reservation;
    002
    003import java.util.Collection;
    004
    005import org.cpsolver.studentsct.model.Offering;
    006
    007/**
    008 * Reservation override. A special instance of the {@link IndividualReservation}
    009 * for a particular student (or students) that allows for defining whether
    010 * it must be used, whether time conflicts are allowed, and whether it
    011 * is allowed to assign the student over the limit. This class is intended to be used
    012 * to model student overrides.
    013 *
    014 * <br>
    015 * <br>
    016 *
    017 * @author  Tomáš Müller
    018 * @version StudentSct 1.3 (Student Sectioning)<br>
    019 *          Copyright (C) 2007 - 2014 Tomáš Müller<br>
    020 *          <a href="mailto:muller@unitime.org">muller@unitime.org</a><br>
    021 *          <a href="http://muller.unitime.org">http://muller.unitime.org</a><br>
    022 * <br>
    023 *          This library is free software; you can redistribute it and/or modify
    024 *          it under the terms of the GNU Lesser General Public License as
    025 *          published by the Free Software Foundation; either version 3 of the
    026 *          License, or (at your option) any later version. <br>
    027 * <br>
    028 *          This library is distributed in the hope that it will be useful, but
    029 *          WITHOUT ANY WARRANTY; without even the implied warranty of
    030 *          MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
    031 *          Lesser General Public License for more details. <br>
    032 * <br>
    033 *          You should have received a copy of the GNU Lesser General Public
    034 *          License along with this library; if not see
    035 *          <a href='http://www.gnu.org/licenses/'>http://www.gnu.org/licenses/</a>.
    036 */
    037public class ReservationOverride extends IndividualReservation {
    038    /**
    039     * Reservation priority (lower than individual and group reservations)
    040     */
    041    public static final int DEFAULT_PRIORITY = 300;
    042    /**
    043     * Reservation override does not need to be used by default
    044     */
    045    public static final boolean DEFAULT_MUST_BE_USED = false;
    046    /**
    047     * Reservation override cannot be assigned over the limit by default.
    048     */
    049    public static final boolean DEFAULT_CAN_ASSIGN_OVER_LIMIT = false;
    050    /**
    051     * Overlaps are not allowed for group reservation overrides by default.
    052     */
    053    public static final boolean DEFAULT_ALLOW_OVERLAP = false;
    054
    055    /**
    056     * Constructor
    057     * @param id unique id
    058     * @param offering offering for which the reservation is
    059     * @param studentIds one or more students
    060     */
    061    public ReservationOverride(long id, Offering offering, Long... studentIds) {
    062        super(id, offering, DEFAULT_PRIORITY, DEFAULT_MUST_BE_USED, DEFAULT_CAN_ASSIGN_OVER_LIMIT, DEFAULT_ALLOW_OVERLAP, studentIds);
    063    }
    064
    065    /**
    066     * Constructor
    067     * @param id unique id
    068     * @param offering offering for which the reservation is
    069     * @param studentIds one or more students
    070     */
    071    public ReservationOverride(long id, Offering offering, Collection<Long> studentIds) {
    072        super(id, offering, DEFAULT_PRIORITY, DEFAULT_MUST_BE_USED, DEFAULT_CAN_ASSIGN_OVER_LIMIT, DEFAULT_ALLOW_OVERLAP, studentIds);
    073    }
    074
    075    @Override
    076    /**
    077     * Override reservation ignore expiration date when checking if they must be used.
    078     */
    079    public boolean mustBeUsed() {
    080        return mustBeUsedIgnoreExpiration();
    081    }
    082}