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