Merge pull request #1668 from ricardorcr/newRule/ACDM-1789

Added new enrolment rule base on last digit student number ACDM-1789 #resolve

src/main/dml/fenixedu-academic.dml

@@ -2319,6 +2319,12 @@ valueType org.fenixedu.academic.domain.accounting.DueDateAmountMap as DueDateAmo
                 AcademicPeriod academicPeriod;
                 Boolean even;
             }
+
+            class curricularRules.LastDigitSplitRule extends curricularRules.Rule {
+                Integer curricularPeriodOrder;
+                AcademicPeriod academicPeriod;
+                Boolean firstHalf;
+            }
 
             class curricularRules.MaximumNumberOfCreditsForEnrolmentPeriod extends curricularRules.Rule {
             }

src/main/java/org/fenixedu/academic/domain/curricularRules/CurricularRuleType.java

@@ -63,7 +63,9 @@ public enum CurricularRuleType {
 
     PHD_VALID_CURRICULAR_COURSES,
 
-    SENIOR_STATUTE_SCOPE;
+    SENIOR_STATUTE_SCOPE,
+
+    LAST_DIGIT_SPLIT;
 
     public String getName() {
         return name();

src/main/java/org/fenixedu/academic/domain/curricularRules/CurricularRulesManager.java

@@ -72,6 +72,9 @@ public static CurricularRule createCurricularRule(DegreeModule toApplyRule, Exec
 
         case EVEN_ODD:
             return createEvenOdd(toApplyRule, begin, end, parametersDTO);
+
+        case LAST_DIGIT_SPLIT:
+            return createLastDigitSplit(toApplyRule, begin, end, parametersDTO);            
 
         default:
             break;
@@ -108,6 +111,17 @@ private static CurricularRule createEvenOdd(DegreeModule toApplyRule, ExecutionS
                 parametersDTO.getCurricularPeriodInfoDTO().getPeriodType(), parametersDTO.getEven(), begin, end);
 
     }
+
+    private static CurricularRule createLastDigitSplit(DegreeModule toApplyRule, ExecutionSemester begin, ExecutionSemester end,
+            CurricularRuleParametersDTO parametersDTO) {
+
+        final CourseGroup contextCourseGroup =
+                (CourseGroup) FenixFramework.getDomainObject(parametersDTO.getContextCourseGroupID());
+
+        return new LastDigitSplitRule(toApplyRule, contextCourseGroup, parametersDTO.getCurricularPeriodInfoDTO().getOrder(),
+                parametersDTO.getCurricularPeriodInfoDTO().getPeriodType(), parametersDTO.getFirstHalf(), begin, end);
+
+    }
 
     private static CurricularRule createAnyCurricularCourse(DegreeModule toApplyRule, ExecutionSemester begin,
             ExecutionSemester end, CurricularRuleParametersDTO parametersDTO) {

src/main/java/org/fenixedu/academic/domain/curricularRules/LastDigitSplitRule.java

@@ -0,0 +1,110 @@
+/**
+ * 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.curricularRules;
+
+import java.util.ArrayList;
+import java.util.List;
+import java.util.Locale;
+
+import org.fenixedu.academic.domain.ExecutionSemester;
+import org.fenixedu.academic.domain.curricularRules.executors.verifyExecutors.LastDigitSplitRuleVerifier;
+import org.fenixedu.academic.domain.curricularRules.executors.verifyExecutors.VerifyRuleExecutor;
+import org.fenixedu.academic.domain.degreeStructure.Context;
+import org.fenixedu.academic.domain.degreeStructure.CourseGroup;
+import org.fenixedu.academic.domain.degreeStructure.DegreeModule;
+import org.fenixedu.academic.domain.exceptions.DomainException;
+import org.fenixedu.academic.domain.time.calendarStructure.AcademicPeriod;
+import org.fenixedu.academic.dto.GenericPair;
+import org.fenixedu.academic.util.Bundle;
+import org.fenixedu.bennu.core.i18n.BundleUtil;
+import org.fenixedu.commons.i18n.LocalizedString;
+
+public class LastDigitSplitRule extends LastDigitSplitRule_Base {
+
+    public LastDigitSplitRule(final DegreeModule toApplyRule, final CourseGroup contextCourseGroup, final Integer semester,
+            final AcademicPeriod academicPeriod, final Boolean firstHalf, final ExecutionSemester begin, final ExecutionSemester end) {
+        super();
+        checkParameters(toApplyRule, semester, academicPeriod, firstHalf);
+        init(toApplyRule, contextCourseGroup, begin, end, CurricularRuleType.LAST_DIGIT_SPLIT);
+        setFirstHalf(firstHalf);
+        setCurricularPeriodOrder(semester);
+        setAcademicPeriod(academicPeriod);
+    }
+
+    private void checkParameters(final DegreeModule toApplyRule, final Integer semester, final AcademicPeriod academicPeriod,
+            final Boolean firstHalf) {
+        if (semester == null) {
+            throw new DomainException("curricular.rule.invalid.parameters");
+        }
+        if (firstHalf == null) {
+            throw new DomainException("curricular.rule.invalid.parameters");
+        }
+        if (academicPeriod == null) {
+            throw new DomainException("curricular.rule.invalid.parameters");
+        }
+        if (!toApplyRule.isLeaf()) {
+            throw new DomainException("curricular.rule.invalid.parameters");
+        }
+
+    }
+
+    @Override
+    public List<GenericPair<Object, Boolean>> getLabel() {
+        final List<GenericPair<Object, Boolean>> labelList = new ArrayList<GenericPair<Object, Boolean>>();
+
+        labelList.add(new GenericPair<Object, Boolean>("label.in", true));
+        labelList.add(new GenericPair<Object, Boolean>(" ", false));
+        labelList.add(new GenericPair<Object, Boolean>("label.semester." + getCurricularPeriodOrder(), true));
+        labelList.add(new GenericPair<Object, Boolean>(", ", false));
+        labelList.add(new GenericPair<Object, Boolean>("label.only.students", true));
+        labelList.add(new GenericPair<Object, Boolean>(" ", false));
+        String digitSplit = getFirstHalf() ? "firstHalf" : "secondHalf";
+        labelList.add(new GenericPair<Object, Boolean>("label." + digitSplit, true));
+        labelList.add(new GenericPair<Object, Boolean>(" ", false));
+        labelList.add(new GenericPair<Object, Boolean>("label.can.be.enroled", true));
+
+        return labelList;
+    }
+
+    @Override
+    protected void removeOwnParameters() {
+    }
+
+    @Override
+    public boolean appliesToContext(Context context) {
+        return super.appliesToContext(context) && appliesToPeriod(context);
+    }
+
+    private boolean appliesToPeriod(Context context) {
+        return context == null
+                || context.getCurricularPeriod().hasCurricularPeriod(getAcademicPeriod(), getCurricularPeriodOrder());
+
+    }
+
+    @Override
+    public VerifyRuleExecutor createVerifyRuleExecutor() {
+        return new LastDigitSplitRuleVerifier();
+    }
+
+    public String getLastDigitSplitString() {
+        return new LocalizedString(org.fenixedu.academic.util.LocaleUtils.PT, BundleUtil.getString(Bundle.ACADEMIC, new Locale("pt", "PT"),
+                "label." + (getFirstHalf() ? "firstHalf" : "secondHalf"))).getContent();
+    }
+
+}

src/main/java/org/fenixedu/academic/domain/curricularRules/executors/ruleExecutors/CurricularRuleExecutorFactory.java

@@ -32,6 +32,7 @@
 import org.fenixedu.academic.domain.curricularRules.Exclusiveness;
 import org.fenixedu.academic.domain.curricularRules.ICurricularRule;
 import org.fenixedu.academic.domain.curricularRules.ImprovementOfApprovedEnrolment;
+import org.fenixedu.academic.domain.curricularRules.LastDigitSplitRule;
 import org.fenixedu.academic.domain.curricularRules.MaximumNumberOfCreditsForEnrolmentPeriod;
 import org.fenixedu.academic.domain.curricularRules.MaximumNumberOfECTSInSpecialSeasonEvaluation;
 import org.fenixedu.academic.domain.curricularRules.MaximumNumberOfEctsInStandaloneCurriculumGroup;
@@ -72,6 +73,7 @@ public class CurricularRuleExecutorFactory {
                 new MaximumNumberOfECTSInSpecialSeasonEvaluationExecutor());
         executors.put(CreditsLimitInExternalCycle.class, new CreditsLimitInExternalCycleExecutor());
         executors.put(EvenOddRule.class, new EvenOddExecuter());
+        executors.put(LastDigitSplitRule.class, new LastDigitSplitExecuter());
         executors.put(MaximumNumberOfEctsInStandaloneCurriculumGroup.class,
                 new MaximumNumberOfEctsInStandaloneCurriculumGroupExecutor());
         executors.put(PhdValidCurricularCoursesRule.class, new PhdValidCurricularCoursesExecutor());

src/main/java/org/fenixedu/academic/domain/curricularRules/executors/ruleExecutors/LastDigitSplitExecuter.java

@@ -0,0 +1,78 @@
+/**
+ * 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.curricularRules.executors.ruleExecutors;
+
+import org.fenixedu.academic.domain.curricularRules.ICurricularRule;
+import org.fenixedu.academic.domain.curricularRules.LastDigitSplitRule;
+import org.fenixedu.academic.domain.curricularRules.executors.RuleResult;
+import org.fenixedu.academic.domain.enrolment.EnrolmentContext;
+import org.fenixedu.academic.domain.enrolment.IDegreeModuleToEvaluate;
+
+public class LastDigitSplitExecuter extends CurricularRuleExecutor {
+
+    @Override
+    protected RuleResult executeEnrolmentInEnrolmentEvaluation(ICurricularRule curricularRule,
+            IDegreeModuleToEvaluate sourceDegreeModuleToEvaluate, EnrolmentContext enrolmentContext) {
+        return RuleResult.createNA(sourceDegreeModuleToEvaluate.getDegreeModule());
+    }
+
+    @Override
+    protected RuleResult executeEnrolmentVerificationWithRules(ICurricularRule curricularRule,
+            IDegreeModuleToEvaluate sourceDegreeModuleToEvaluate, EnrolmentContext enrolmentContext) {
+        final LastDigitSplitRule lastDigitSplitRule = (LastDigitSplitRule) curricularRule;
+        if (!canApplyRule(enrolmentContext, lastDigitSplitRule)) {
+            return RuleResult.createNA(sourceDegreeModuleToEvaluate.getDegreeModule());
+        }
+
+        String studentNumber = enrolmentContext.getRegistration().getStudent().getNumber().toString();
+        if (lastDigitSplitRule.getFirstHalf() && isFirstHalf(studentNumber) || !lastDigitSplitRule.getFirstHalf() && isSecondHalf(studentNumber)) {
+            return RuleResult.createTrue(sourceDegreeModuleToEvaluate.getDegreeModule());
+        }
+        return createFalseRuleResult(lastDigitSplitRule, sourceDegreeModuleToEvaluate);
+    }   
+
+    @Override
+    protected RuleResult executeEnrolmentWithRulesAndTemporaryEnrolment(ICurricularRule curricularRule,
+            IDegreeModuleToEvaluate sourceDegreeModuleToEvaluate, EnrolmentContext enrolmentContext) {
+        return executeEnrolmentVerificationWithRules(curricularRule, sourceDegreeModuleToEvaluate, enrolmentContext);
+    }
+
+    private RuleResult createFalseRuleResult(final LastDigitSplitRule rule, final IDegreeModuleToEvaluate sourceDegreeModuleToEvaluate) {
+        return RuleResult.createFalse(sourceDegreeModuleToEvaluate.getDegreeModule(),
+                "curricularRules.ruleExecutors.LastDigitSplitExecutor.invalid.number", rule.getLastDigitSplitString(), rule
+                        .getDegreeModuleToApplyRule().getName());
+    }
+
+    private boolean isFirstHalf(String studentNumber) {
+        int lastDigit = Integer.valueOf(studentNumber.substring(studentNumber.length()-1));
+        return lastDigit < 5;
+    }
+
+    private boolean isSecondHalf(String studentNumber) {
+        int lastDigit = Integer.valueOf(studentNumber.substring(studentNumber.length()-1));
+        return lastDigit >= 5;
+    }
+
+    @Override
+    protected boolean canBeEvaluated(ICurricularRule curricularRule, IDegreeModuleToEvaluate sourceDegreeModuleToEvaluate,
+            EnrolmentContext enrolmentContext) {
+        return true;
+    }
+
+}

src/main/java/org/fenixedu/academic/domain/curricularRules/executors/verifyExecutors/LastDigitSplitRuleVerifier.java

@@ -0,0 +1,54 @@
+/**
+ * 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.curricularRules.executors.verifyExecutors;
+
+import org.fenixedu.academic.domain.curricularRules.ICurricularRule;
+import org.fenixedu.academic.domain.curricularRules.LastDigitSplitRule;
+import org.fenixedu.academic.domain.curricularRules.executors.RuleResult;
+import org.fenixedu.academic.domain.degreeStructure.CourseGroup;
+import org.fenixedu.academic.domain.degreeStructure.DegreeModule;
+import org.fenixedu.academic.domain.enrolment.EnrolmentContext;
+
+public class LastDigitSplitRuleVerifier extends VerifyRuleExecutor {
+
+    @Override
+    protected RuleResult verifyEnrolmentWithRules(ICurricularRule curricularRule, EnrolmentContext enrolmentContext,
+            DegreeModule degreeModuleToVerify, CourseGroup parentCourseGroup) {
+        final LastDigitSplitRule lastDigitRule = (LastDigitSplitRule) curricularRule;
+
+        if (lastDigitRule.getCurricularPeriodOrder().equals(enrolmentContext.getExecutionPeriod().getSemester())) {
+            String studentNumber = enrolmentContext.getRegistration().getStudent().getNumber().toString();
+            int lastDigit = Integer.valueOf(studentNumber.substring(studentNumber.length() - 1));
+            if ((lastDigitRule.getFirstHalf() && lastDigit < 5) || (!lastDigitRule.getFirstHalf() && lastDigit >= 5)) {
+                return RuleResult.createTrue(degreeModuleToVerify);
+            }
+
+            return RuleResult.createFalse(degreeModuleToVerify);
+        } else {
+            return RuleResult.createNA(degreeModuleToVerify);
+        }
+    }
+
+    @Override
+    protected RuleResult verifyEnrolmentWithTemporaryEnrolment(ICurricularRule curricularRule, EnrolmentContext enrolmentContext,
+            DegreeModule degreeModuleToVerify, CourseGroup parentCourseGroup) {
+        return verifyEnrolmentWithRules(curricularRule, enrolmentContext, degreeModuleToVerify, parentCourseGroup);
+    }
+
+}

src/main/java/org/fenixedu/academic/dto/bolonhaManager/CurricularRuleParametersDTO.java

@@ -41,6 +41,7 @@ public class CurricularRuleParametersDTO extends DataTranferObject {
     private Double credits;
     private DegreeType degreeType;
     private Boolean even;
+    private Boolean firstHalf;
 
     public CurricularRuleParametersDTO() {
     }
@@ -156,4 +157,12 @@ public Boolean getEven() {
     public void setEven(Boolean even) {
         this.even = even;
     }
+
+    public Boolean getFirstHalf() {
+        return firstHalf;
+    }
+
+    public void setFirstHalf(Boolean firstHalf) {
+        this.firstHalf = firstHalf;
+    }
 }

src/main/java/org/fenixedu/academic/ui/faces/bean/bolonhaManager/curricularRules/CurricularRulesManagementBackingBean.java

@@ -207,7 +207,14 @@ private List<SelectItem> getRuleTypes() {
                             curricularRuleType.getName())));
                 }
                 break;
-
+
+            case LAST_DIGIT_SPLIT:
+                if (getDegreeModule().isLeaf()) {
+                    result.add(new SelectItem(curricularRuleType.getName(), BundleUtil.getString(Bundle.ENUMERATION,
+                            curricularRuleType.getName())));
+                }
+                break;
+
             case MINIMUM_NUMBER_OF_CREDITS_TO_ENROL:
                 result.add(new SelectItem(curricularRuleType.getName(), BundleUtil.getString(Bundle.ENUMERATION,
                         curricularRuleType.getName())));
@@ -377,6 +384,14 @@ public void setSelectedEven(String selectedSemester) {
     public String getSelectedEven() {
         return (String) getViewState().getAttribute("even");
     }
+
+    public void setSelectedFirstHalf(String selectedFirstHalf) {
+        getViewState().setAttribute("firstHalf", selectedFirstHalf);
+    }
+
+    public String getSelectedFirstHalf() {
+        return (String) getViewState().getAttribute("firstHalf");
+    }
 
     public String getCurricularRuleID() {
         return getAndHoldStringParameter("curricularRuleID");
@@ -821,6 +836,7 @@ private CurricularRuleParametersDTO buildCurricularRuleParametersDTO() throws Fe
         parametersDTO.setMaximumYear((Integer) getViewState().getAttribute("maximumYear"));
         parametersDTO.setCredits((Double) getViewState().getAttribute("credits"));
         parametersDTO.setEven(Boolean.valueOf(getSelectedEven()));
+        parametersDTO.setFirstHalf(Boolean.valueOf(getSelectedFirstHalf()));
         return parametersDTO;
     }
 }

src/main/resources/resources/AcademicAdminOffice_en.properties

@@ -145,6 +145,7 @@ curricularRules.ruleExecutors.ImprovementOfApprovedEnrolmentExecutor.is.not.impr
 curricularRules.ruleExecutors.MaximumNumberOfCreditsForEnrolmentPeriodExecutor = It is not permitted to enroll in more than {0} ECTS credits for each semester; these enrollments would leave {1} ECTS
 curricularRules.ruleExecutors.MaximumNumberOfEctsInStandaloneCurriculumGroupExecutor = The maximum of ECTS credits is {0}; these inscriptions would leave {1}
 curricularRules.ruleExecutors.MinimumNumberOfCreditsToEnrolExecutor.student.has.not.minimum.number.of.credits = The number of ECTS that you have ({0}) is less than the minimum allowed ({1}) to enroll in '{2}'
+curricularRules.ruleExecutors.LastDigitSplitExecutor.invalid.number = Only students with numbers ending with {0} may enroll in '{1}'
 curricularRules.ruleExecutors.PhdValidCurricularCoursesExecutor.invalid.curricularCourse = The course {0} does not exist in the group of courses mentioned in your study plan and as such cannot enroll.
 curricularRules.ruleExecutors.PreviousYearsEnrolmentExecutor = '{0}': to enroll in courses of {1} th year, you must have the approval or enrollment on the courses from previous years, in this semester
 curricularRules.ruleExecutors.RestrictionBetweenDegreeModulesExecutor.invalid.ects.credits.in.precedence.degreeModule = The enrollment on the unit '{0}' has as precedence the unit '{1}' with {2} ECTS
@@ -549,6 +550,7 @@ label.NOT_STARTED = Por Iniciar
 label.Person.lastValidationRequestDate = Date of last request
 label.Person.numberOfValidationRequests = Total of messages/calls sent
 label.SELECT_CANDIDACIES = Colocação Candidatos
+label.secondHalf = 5-9
 label.SecondCycleIndividualCandidacy.affinity = Affinity
 label.SecondCycleIndividualCandidacy.candidacyGrade = Application Grade
 label.SecondCycleIndividualCandidacy.degreeNature = Nature
@@ -1178,6 +1180,7 @@ label.fatherProfessionType = Father's current occupation (or former, in case of
 label.fatherProfessionalCondition = Father's professional status
 label.fatherSchoolLevel = Father's highest complete qualification
 label.final.evaluations = Published grades
+lable.firstHalf = 0-4
 label.firstCycle.average = Average (1st Cycle)
 label.firstCycle.concluded = 1st Cycle Concluded
 label.firstCycle.conclusionDate = Conclusion Date (1st Cycle)