/**
* Copyright © 2002 Instituto Superior Técnico
*
* This file is part of FenixEdu Academic.
*
* FenixEdu Academic is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* FenixEdu Academic is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with FenixEdu Academic. If not, see <http://www.gnu.org/licenses/>.
*/
package org.fenixedu.academic.domain.studentCurriculum;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
import java.util.Set;
import org.fenixedu.academic.domain.CurricularCourse;
import org.fenixedu.academic.domain.Enrolment;
import org.fenixedu.academic.domain.curricularRules.AssertUniqueApprovalInCurricularCourseContexts;
import org.fenixedu.academic.domain.curricularRules.ICurricularRule;
import org.fenixedu.academic.domain.curricularRules.PreviousYearsEnrolmentCurricularRule;
import org.fenixedu.academic.domain.curricularRules.executors.RuleResult;
import org.fenixedu.academic.domain.curricularRules.executors.ruleExecutors.EnrolmentResultType;
import org.fenixedu.academic.domain.curriculum.EnrollmentCondition;
import org.fenixedu.academic.domain.degreeStructure.CourseGroup;
import org.fenixedu.academic.domain.degreeStructure.DegreeModule;
import org.fenixedu.academic.domain.degreeStructure.OptionalCurricularCourse;
import org.fenixedu.academic.domain.enrolment.EnroledCurriculumModuleWrapper;
import org.fenixedu.academic.domain.enrolment.EnrolmentContext;
import org.fenixedu.academic.domain.enrolment.IDegreeModuleToEvaluate;
import org.fenixedu.academic.domain.enrolment.OptionalDegreeModuleToEnrol;
import org.fenixedu.academic.domain.exceptions.DomainException;
public class StudentCurricularPlanEnrolmentManager extends StudentCurricularPlanEnrolment {
public StudentCurricularPlanEnrolmentManager(final EnrolmentContext enrolmentContext) {
super(enrolmentContext);
}
@Override
protected void assertEnrolmentPreConditions() {
if (!isResponsiblePersonManager() && !getRegistration().isRegistered(getExecutionSemester())) {
throw new DomainException("error.StudentCurricularPlan.cannot.enrol.with.registration.inactive");
}
super.assertEnrolmentPreConditions();
}
@Override
protected void unEnrol() {
// First remove Enrolments
for (final CurriculumModule curriculumModule : enrolmentContext.getToRemove()) {
if (curriculumModule.isLeaf()) {
curriculumModule.delete();
}
}
// After, remove CurriculumGroups and evaluate rules
for (final CurriculumModule curriculumModule : enrolmentContext.getToRemove()) {
if (!curriculumModule.isLeaf()) {
curriculumModule.delete();
}
}
}
@Override
protected void addEnroled() {
for (final IDegreeModuleToEvaluate degreeModuleToEvaluate : getStudentCurricularPlan().getDegreeModulesToEvaluate(
getExecutionSemester())) {
enrolmentContext.addDegreeModuleToEvaluate(degreeModuleToEvaluate);
}
}
@Override
protected Map<IDegreeModuleToEvaluate, Set<ICurricularRule>> getRulesToEvaluate() {
final Map<IDegreeModuleToEvaluate, Set<ICurricularRule>> result =
new HashMap<IDegreeModuleToEvaluate, Set<ICurricularRule>>();
for (final IDegreeModuleToEvaluate degreeModuleToEvaluate : enrolmentContext.getDegreeModulesToEvaluate()) {
if (degreeModuleToEvaluate.canCollectRules()) {
final Set<ICurricularRule> curricularRules = new HashSet<ICurricularRule>();
curricularRules.addAll(degreeModuleToEvaluate.getCurricularRulesFromDegreeModule(getExecutionSemester()));
curricularRules.addAll(degreeModuleToEvaluate.getCurricularRulesFromCurriculumGroup(getExecutionSemester()));
if (degreeModuleToEvaluate.isLeaf()) {
final CurricularCourse curricularCourse = (CurricularCourse) degreeModuleToEvaluate.getDegreeModule();
addRuntimeRules(curricularRules, curricularCourse);
}
result.put(degreeModuleToEvaluate, curricularRules);
}
}
return result;
}
protected void addRuntimeRules(final Set<ICurricularRule> curricularRules, final CurricularCourse curricularCourse) {
curricularRules.add(new AssertUniqueApprovalInCurricularCourseContexts(curricularCourse));
}
@Override
protected void performEnrolments(final Map<EnrolmentResultType, List<IDegreeModuleToEvaluate>> degreeModulesEnrolMap) {
final String createdBy = getResponsiblePerson().getUsername();
for (final Entry<EnrolmentResultType, List<IDegreeModuleToEvaluate>> entry : degreeModulesEnrolMap.entrySet()) {
if (entry.getKey() == EnrolmentResultType.NULL) {
continue;
}
for (final IDegreeModuleToEvaluate degreeModuleToEvaluate : entry.getValue()) {
if (degreeModuleToEvaluate.isEnroled()) {
final EnroledCurriculumModuleWrapper moduleEnroledWrapper =
(EnroledCurriculumModuleWrapper) degreeModuleToEvaluate;
if (moduleEnroledWrapper.getCurriculumModule() instanceof Enrolment) {
final Enrolment enrolment = (Enrolment) moduleEnroledWrapper.getCurriculumModule();
enrolment.setEnrolmentCondition(getEnrolmentCondition(enrolment, entry.getKey()));
}
} else {
final DegreeModule degreeModule = degreeModuleToEvaluate.getDegreeModule();
final CurriculumGroup curriculumGroup = degreeModuleToEvaluate.getCurriculumGroup();
if (degreeModule.isLeaf()) {
if (degreeModuleToEvaluate.isOptional()) {
createOptionalEnrolmentFor(getEnrolmentCondition(null, entry.getKey()), degreeModuleToEvaluate,
curriculumGroup);
} else {
new Enrolment(getStudentCurricularPlan(), curriculumGroup, (CurricularCourse) degreeModule,
getExecutionSemester(), getEnrolmentCondition(null, entry.getKey()), createdBy);
}
} else {
CurriculumGroupFactory.createGroup(degreeModuleToEvaluate.getCurriculumGroup(),
(CourseGroup) degreeModule, getExecutionSemester());
}
}
}
}
}
protected EnrollmentCondition getEnrolmentCondition(final Enrolment enrolment, final EnrolmentResultType enrolmentResultType) {
return enrolmentResultType.getEnrollmentCondition();
}
private void createOptionalEnrolmentFor(final EnrollmentCondition enrollmentCondition,
final IDegreeModuleToEvaluate degreeModuleToEvaluate, final CurriculumGroup curriculumGroup) {
final OptionalDegreeModuleToEnrol optionalDegreeModuleToEnrol = (OptionalDegreeModuleToEnrol) degreeModuleToEvaluate;
final OptionalCurricularCourse optionalCurricularCourse =
(OptionalCurricularCourse) optionalDegreeModuleToEnrol.getDegreeModule();
final CurricularCourse curricularCourse = optionalDegreeModuleToEnrol.getCurricularCourse();
getStudentCurricularPlan().createOptionalEnrolment(curriculumGroup, getExecutionSemester(), optionalCurricularCourse,
curricularCourse, enrollmentCondition);
}
@Override
protected RuleResult evaluateExtraRules(RuleResult actualResult) {
if (actualResult.isFalse() || !getDegreeCurricularPlan().isToApplyPreviousYearsEnrolmentRule()) {
return actualResult;
}
RuleResult finalResult = RuleResult.createInitialTrue();
if (!getRoot().hasExternalCycles()) {
final PreviousYearsEnrolmentCurricularRule previousYearsEnrolmentCurricularRule =
new PreviousYearsEnrolmentCurricularRule(getRoot().getDegreeModule());
finalResult =
finalResult.and(previousYearsEnrolmentCurricularRule.evaluate(new EnroledCurriculumModuleWrapper(getRoot(),
getExecutionSemester()), this.enrolmentContext));
} else {
for (final CycleCurriculumGroup cycleCurriculumGroup : getRoot().getCycleCurriculumGroups()) {
final PreviousYearsEnrolmentCurricularRule previousYearsEnrolmentCurricularRule =
new PreviousYearsEnrolmentCurricularRule(cycleCurriculumGroup.getDegreeModule());
finalResult =
finalResult.and(previousYearsEnrolmentCurricularRule.evaluate(new EnroledCurriculumModuleWrapper(
cycleCurriculumGroup, getExecutionSemester()), this.enrolmentContext));
}
}
return finalResult.and(actualResult);
}
}