001package org.cpsolver.studentsct.reservation;
002
003import java.util.Collection;
004
005import org.cpsolver.studentsct.model.Course;
006import org.cpsolver.studentsct.model.Student;
007
008/**
009 * Learning Community reservation. This is a combination of {@link GroupReservation}
010 * and {@link CourseReservation}. Space is reserved for students of a group but only when
011 * they enroll into the offering through the given course.
012 * 
013 * <br>
014 * <br>
015 * 
016 * @author  Tomáš Müller
017 * @version StudentSct 1.3 (Student Sectioning)<br>
018 *          Copyright (C) 2007 - 2014 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 LearningCommunityReservation extends GroupReservation {
037    private Course iCourse;
038    
039    /**
040     * Learning Community reservations are just a below student group reservations.
041     */
042    public static final int DEFAULT_PRIORITY = 250;
043    /**
044     * Learning Community reservation must be used (unless it is expired)
045     */
046    public static final boolean DEFAULT_MUST_BE_USED = true;
047    /**
048     * Learning Community reservations cannot be assigned over the limit.
049     */
050    public static final boolean DEFAULT_CAN_ASSIGN_OVER_LIMIT = false;
051    /**
052     * Overlaps are not allowed for Learning Community reservations. 
053     */
054    public static final boolean DEFAULT_ALLOW_OVERLAP = false;
055
056    /**
057     * Constructor
058     * @param id unique id
059     * @param limit reservation limit (-1 for unlimited)
060     * @param course course offering for which the reservation is
061     * @param studentIds one or more students
062     */
063    public LearningCommunityReservation(long id, double limit, Course course, Long... studentIds) {
064        super(id, limit, course.getOffering(), DEFAULT_PRIORITY, DEFAULT_MUST_BE_USED, DEFAULT_CAN_ASSIGN_OVER_LIMIT, DEFAULT_ALLOW_OVERLAP, studentIds);
065        iCourse = course;
066    }
067    
068    /**
069     * Constructor
070     * @param id unique id
071     * @param limit reservation limit (-1 for unlimited)
072     * @param course course offering for which the reservation is
073     * @param studentIds one or more students
074     */
075    public LearningCommunityReservation(long id, double limit, Course course, Collection<Long> studentIds) {
076        super(id, limit, course.getOffering(), DEFAULT_PRIORITY, DEFAULT_MUST_BE_USED, DEFAULT_CAN_ASSIGN_OVER_LIMIT, DEFAULT_ALLOW_OVERLAP, studentIds);
077        iCourse = course;
078    }
079
080    /**
081     * Reservation limit (-1 for unlimited)
082     */
083    @Override
084    public double getReservationLimit() {
085        if (super.getReservationLimit() < 0.0)
086            return iCourse.getLimit(); // no group limit >> return course limit
087        else if (iCourse.getLimit()  < 0.0)
088            return super.getReservationLimit(); // course unlimited >> return group limit
089        else
090            return Math.min(super.getReservationLimit(), iCourse.getLimit()); // return smaller of the two limits
091    }
092    
093    /**
094     * Course offering
095     * @return course offering
096     */
097    public Course getCourse() {
098        return iCourse;
099    }
100    
101    /**
102     * Check the student group and the course
103     */
104    @Override
105    public boolean isApplicable(Student student, Course course) {
106        if (!super.isApplicable(student, course)) return false;
107        return course != null && course.equals(getCourse());
108    }
109}