    001package org.cpsolver.studentsct.constraint;
    002
    003import java.util.Set;
    004
    005import org.cpsolver.ifs.assignment.Assignment;
    006import org.cpsolver.ifs.model.GlobalConstraint;
    007import org.cpsolver.studentsct.model.CourseRequest;
    008import org.cpsolver.studentsct.model.Enrollment;
    009import org.cpsolver.studentsct.model.Request;
    010
    011
    012/**
    013 * Required restrictions constraint. This global constraint ensures that no enrollment
    014 * is violating a restriction. That is, for each student that has at least one restriction
    015 * on the requested course, the given enrollment must match at least one of the restrictions.
    016 *
    017 * @version StudentSct 1.3 (Student Sectioning)<br>
    018 *          Copyright (C) 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 RequiredRestrictions extends GlobalConstraint<Request, Enrollment> {
    037
    038    /**
    039     * A given enrollment is conflicting, if there is restriction that is not met.
    040     *
    041     * @param enrollment {@link Enrollment} that is being considered
    042     * @param conflicts all computed conflicting requests are added into this set
    043     */
    044    @Override
    045    public void computeConflicts(Assignment<Request, Enrollment> assignment, Enrollment enrollment, Set<Enrollment> conflicts) {
    046        if (inConflict(assignment, enrollment))
    047            conflicts.add(enrollment);
    048    }
    049
    050    /**
    051     * A given enrollment is conflicting, if there is restriction that is not met.
    052     *
    053     * @param enrollment {@link Enrollment} that is being considered
    054     * @return true, if the enrollment does not follow a reservation that must be used
    055     */
    056    @Override
    057    public boolean inConflict(Assignment<Request, Enrollment> assignment, Enrollment enrollment) {
    058        return enrollment.isCourseRequest() && ((CourseRequest)enrollment.getRequest()).isNotAllowed(enrollment);
    059    }
    060
    061    @Override
    062    public String toString() {
    063        return "RequiredRestrictions";
    064    }
    065}