001package org.cpsolver.studentsct.reservation;
002
003import java.util.Collection;
004import java.util.HashSet;
005import java.util.Set;
006
007import org.cpsolver.studentsct.model.Offering;
008import org.cpsolver.studentsct.model.Student;
009
010/**
011 * Individual restriction. A restriction for a particular student (or students).
012 * 
013 * <br>
014 * <br>
015 * 
016 * @author  Tomáš Müller
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 IndividualRestriction extends Restriction {
037    private Set<Long> iStudentIds = new HashSet<Long>();
038    
039    /**
040     * Constructor
041     * @param id restriction unique id
042     * @param offering instructional offering on which the restriction is set
043     * @param studentIds one or more students
044     */
045    public IndividualRestriction(long id, Offering offering, Long... studentIds) {
046        super(id, offering);
047        for (Long studentId: studentIds) {
048            iStudentIds.add(studentId);
049        }
050    }
051
052    /**
053     * Constructor
054     * @param id restriction unique id
055     * @param offering instructional offering on which the restriction is set
056     * @param studentIds one or more students
057     */
058    public IndividualRestriction(long id, Offering offering, Collection<Long> studentIds) {
059        super(id, offering);
060        iStudentIds.addAll(studentIds);
061    }
062
063    /**
064     * Restriction is applicable for all students in the restriction
065     */
066    @Override
067    public boolean isApplicable(Student student) {
068        return iStudentIds.contains(student.getId());
069    }
070    
071    /**
072     * Students in the restriction
073     * @return set of student ids associated with this restriction
074     */
075    public Set<Long> getStudentIds() {
076        return iStudentIds;
077    }
078}