File: /var/www/html/unitime/Documentation/Scripts/Create Max Holes Constraint.xml
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE script PUBLIC "-//UniTime//DTD University Course Timetabling/EN" "http://www.unitime.org/interface/Script.dtd">
<!--
* Licensed to The Apereo Foundation under one or more contributor license
* agreements. See the NOTICE file distributed with this work for
* additional information regarding copyright ownership.
*
* The Apereo Foundation licenses this file to you under the Apache License,
* Version 2.0 (the "License"); you may not use this file except in
* compliance with the License. You may obtain a copy of the License at:
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
*
* See the License for the specific language governing permissions and
* limitations under the License.
*
******************************************************************************
* MaxHoles distribution constraint
* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
* The MaxHoles constraint limits the number of free time (holes) for an instructor
* on a day (between the first and the last class on a day).
* It has one parameter: a maximal amount of free time that an instructor can have
* on a day in minutes.
* For example, reference _MaxHoles:120_ translates to a maximum number of two hours
* of total free time between the first and the last class on a day.
* If required, having more free time is prohibited.
* If preferred or strongly preferred, the excessive free time is penalized
-->
<script name="Distribution Types: Create Max Holes Constraint" permission="Distribution Types" engine="ECMAScript" created="Sun Oct 08 15:34:40 CEST 2017">
<description><![CDATA[The MaxHoles constraint limits the number of free time (holes) for an instructor on a day.<br>It has one parameter: a maximal amount of free time in minutes (between the first and the last class on a day) that an instructor is allowed to have without a penalization.]]></description>
<parameter name="maxHoles" label="Max Hole [in minutes]" type="integer" default="60"/>
<body><![CDATA[var reqId = hibSession.createQuery('select max(requirementId) from DistributionType').uniqueResult();
var reference = '_MaxHoles:' + maxHoles + '_';
var type = hibSession.createQuery('from DistributionType where reference = :reference').setParameter('reference', reference).uniqueResult();
var abbv = 'Minimize Holes';
var label = 'Minimize Free Time On A Day';
var desc = 'There should be less than ' + maxHoles + ' minutes of free time between the first and the last class during any day.';
if (type == null) {
type = new org.unitime.timetable.model.DistributionType();
type.setReference(reference);
log.info('Creating ' + label + ' constraint...');
} else {
log.warn('Constraint ' + label + ' already exists.');
}
type.setLabel(label);
type.setSequencingRequired(false);
type.setRequirementId(++reqId);
type.setAllowedPref('210R');
type.setDescr(desc);
type.setAbbreviation(abbv);
type.setInstructorPref(true);
type.setExamPref(false);
type.setVisible(true);
hibSession.saveOrUpdate(type);
log.info('All done.');]]></body>
</script>