Student Scheduling Disclaimer: Data Entry

tomas-muller · tomas-muller · commit d9d6190ccc13 · 2026-02-04T17:23:32.000+01:00
- added Student Scheduling Disclaimer field on the instructinal offering config level
- editable with InstructionalOfferingEditDisclaimer permission using Instructional Offering Configuration or Multiple Class Setup page
diff --git a/Documentation/Database/MySQL/Changes/275 Student Scheduling Disclaimer.sql b/Documentation/Database/MySQL/Changes/275 Student Scheduling Disclaimer.sql
@@ -0,0 +1,33 @@
+/*
+ * 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.
+ * 
+*/
+
+alter table instr_offering_config add sched_disclaimer varchar(2000) null;
+
+insert into rights (role_id, value)
+	select distinct r.role_id, 'InstrOfferingConfigEditDisclaimer'
+	from roles r, rights g where g.role_id = r.role_id and g.value = 'InstrOfferingConfigEdit';
+
+/*
+ * Update database version
+ */
+  
+update application_config set value='275' where name='tmtbl.db.version';
+
+commit;
diff --git a/Documentation/Database/Oracle/Changes/275 Student Scheduling Disclaimer.sql b/Documentation/Database/Oracle/Changes/275 Student Scheduling Disclaimer.sql
@@ -0,0 +1,33 @@
+/*
+ * 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.
+ * 
+*/
+
+alter table instr_offering_config add sched_disclaimer varchar2(2000 char);
+
+insert into rights (role_id, value)
+	select distinct r.role_id, 'InstrOfferingConfigEditDisclaimer'
+	from roles r, rights g where g.role_id = r.role_id and g.value = 'InstrOfferingConfigEdit';
+
+/*
+ * Update database version
+ */
+  
+update application_config set value='275' where name='tmtbl.db.version';
+
+commit;
diff --git a/Documentation/Database/PostgreSQL/Changes/275 Student Scheduling Disclaimer.sql b/Documentation/Database/PostgreSQL/Changes/275 Student Scheduling Disclaimer.sql
@@ -0,0 +1,33 @@
+/*
+ * 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.
+ * 
+*/
+
+alter table instr_offering_config add sched_disclaimer varchar(2000);
+
+insert into rights (role_id, value)
+	select distinct r.role_id, 'InstrOfferingConfigEditDisclaimer'
+	from roles r, rights g where g.role_id = r.role_id and g.value = 'InstrOfferingConfigEdit';
+
+/*
+ * Update database version
+ */
+  
+update application_config set value='275' where name='tmtbl.db.version';
+
+commit;
diff --git a/JavaSource/InstrOfferingConfig.hbm.xml b/JavaSource/InstrOfferingConfig.hbm.xml
@@ -85,6 +85,13 @@
             type="java.lang.Long"
             not-null="false"
             length="20"/>
+            
+		<property
+            name="schedulingDisclaimer"
+            column="sched_disclaimer"
+            type="java.lang.String"
+            not-null="false"
+            length="2000"/>
 
 		<many-to-one
 			name="classDurationType"
diff --git a/JavaSource/dbupdate.xml b/JavaSource/dbupdate.xml
@@ -15730,4 +15730,20 @@
 		<mysql onFail="next">create index idx_student_enrl_student on %SCHEMA%.student_enrl(student_id)</mysql>
 		<pgsql onFail="next">create index idx_student_enrl_student on %SCHEMA%.student_enrl(student_id)</pgsql>
 	</update>
+	<update version="275" date="3-Feb-2026" comment="Student Scheduling Disclaimer">
+		<mysql>
+			alter table %SCHEMA%.instr_offering_config add sched_disclaimer varchar(2000) null
+		</mysql>
+		<plsql>
+			alter table %SCHEMA%.instr_offering_config add sched_disclaimer varchar2(2000 char)
+		</plsql>
+		<pgsql>
+			alter table %SCHEMA%.instr_offering_config add sched_disclaimer varchar(2000)
+		</pgsql>
+		<sql>
+			insert into %SCHEMA%.rights (role_id, value)
+			select distinct r.role_id, 'InstrOfferingConfigEditDisclaimer'
+			from %SCHEMA%.roles r, %SCHEMA%.rights g where g.role_id = r.role_id and g.value = 'InstrOfferingConfigEdit'
+		</sql>
+	</update>
 </dbupdate>
diff --git a/JavaSource/org/unitime/localization/messages/CourseMessages.java b/JavaSource/org/unitime/localization/messages/CourseMessages.java
@@ -6084,4 +6084,7 @@ public interface CourseMessages extends Messages {
 	
 	@DefaultMessage("No Associated Course")
 	String itemNoParentCourse();
+	
+	@DefaultMessage("Student Scheduling Disclaimer:")
+	String propertySchedulingDisclaimer();
 }
diff --git a/JavaSource/org/unitime/timetable/gwt/client/offerings/InstrOfferingConfigPage.java b/JavaSource/org/unitime/timetable/gwt/client/offerings/InstrOfferingConfigPage.java
@@ -62,6 +62,7 @@
 import com.google.gwt.user.client.ui.Composite;
 import com.google.gwt.user.client.ui.Label;
 import com.google.gwt.user.client.ui.ListBox;
+import com.google.gwt.user.client.ui.TextArea;
 import com.google.gwt.user.client.ui.TextBox;
 import com.google.gwt.user.client.ui.Widget;
 
@@ -311,6 +312,24 @@ public void onValueChange(ValueChangeEvent<String> event) {
 		});
 		iLimitRow = iForm.addRow(MESSAGES.propertyConfigurationLimit(), iLimit);
 		
+		if (iData.isCanEditSchedulingDisclaimer()) {
+			TextArea disclaimer = new TextArea();
+			disclaimer.setHeight("66px");
+			disclaimer.setWidth("100%");
+			if (iData.hasSchedulingDisclaimer()) disclaimer.setText(iData.getSchedulingDisclaimer());
+			iForm.addRow(MESSAGES.propertySchedulingDisclaimer(), disclaimer);
+			disclaimer.addValueChangeHandler(new ValueChangeHandler<String>() {
+				@Override
+				public void onValueChange(ValueChangeEvent<String> event) {
+					iData.setSchedulingDisclaimer(event.getValue());
+				}
+			});
+		} else if (iData.hasSchedulingDisclaimer()) {
+			Label disclaimer = new Label(iData.getSchedulingDisclaimer());
+			disclaimer.addStyleName("note");
+			iForm.addRow(MESSAGES.propertySchedulingDisclaimer(), disclaimer);
+		}
+		
 		if (iData.isDisplayCourseLink()) {
 			CourseDetailsWidget link = new CourseDetailsWidget(true);
 			link.reload(iData.getCourseId());
diff --git a/JavaSource/org/unitime/timetable/gwt/client/offerings/MultipleClassSetupPage.java b/JavaSource/org/unitime/timetable/gwt/client/offerings/MultipleClassSetupPage.java
@@ -61,6 +61,7 @@
 import com.google.gwt.user.client.ui.Image;
 import com.google.gwt.user.client.ui.Label;
 import com.google.gwt.user.client.ui.ListBox;
+import com.google.gwt.user.client.ui.TextArea;
 import com.google.gwt.user.client.ui.Widget;
 
 /**
@@ -245,6 +246,24 @@ public void onValueChange(ValueChangeEvent<String> event) {
 		});
 		iLimitRow = iForm.addRow(MESSAGES.propertyConfigurationLimit(), iLimit);
 		
+		if (iData.isCanEditSchedulingDisclaimer()) {
+			TextArea disclaimer = new TextArea();
+			disclaimer.setHeight("66px");
+			disclaimer.setWidth("100%");
+			if (iData.hasSchedulingDisclaimer()) disclaimer.setText(iData.getSchedulingDisclaimer());
+			iForm.addRow(MESSAGES.propertySchedulingDisclaimer(), disclaimer);
+			disclaimer.addValueChangeHandler(new ValueChangeHandler<String>() {
+				@Override
+				public void onValueChange(ValueChangeEvent<String> event) {
+					iData.setSchedulingDisclaimer(event.getValue());
+				}
+			});
+		} else if (iData.hasSchedulingDisclaimer()) {
+			Label disclaimer = new Label(iData.getSchedulingDisclaimer());
+			disclaimer.addStyleName("note");
+			iForm.addRow(MESSAGES.propertySchedulingDisclaimer(), disclaimer);
+		}
+		
 		P topSubpartLimits = new P("subpart-limits");
 		P bottomSubpartLimits = new P("subpart-limits");
 		P topSnapshotLimits = new P("subpart-limits");
diff --git a/JavaSource/org/unitime/timetable/gwt/client/offerings/OfferingDetailPage.java b/JavaSource/org/unitime/timetable/gwt/client/offerings/OfferingDetailPage.java
@@ -55,6 +55,7 @@
 import com.google.gwt.user.client.rpc.AsyncCallback;
 import com.google.gwt.user.client.ui.Anchor;
 import com.google.gwt.user.client.ui.Composite;
+import com.google.gwt.user.client.ui.Label;
 import com.google.gwt.user.client.ui.SimplePanel;
 
 public class OfferingDetailPage extends Composite {
@@ -278,6 +279,11 @@ public void onSuccess(final OfferingDetailResponse response) {
 					for (final OfferingConfigInterface config: response.getConfigs()) {
 						UniTimeHeaderPanel hp = new UniTimeHeaderPanel(config.getName());
 						iPanel.addHeaderRow(hp);
+						if (config.hasSchedulingDisclaimer()) {
+							Label disclaimer = new Label(config.getSchedulingDisclaimer());
+							disclaimer.addStyleName("note");
+							iPanel.addRow(COURSE.propertySchedulingDisclaimer(), disclaimer);
+						}
 						iPanel.addRow(new TableWidget(config));
 						if (config.hasAnchor()) {
 							Anchor a = new Anchor(); a.setName(config.getAnchor()); a.getElement().setId(config.getAnchor());
diff --git a/JavaSource/org/unitime/timetable/gwt/client/offerings/OfferingsInterface.java b/JavaSource/org/unitime/timetable/gwt/client/offerings/OfferingsInterface.java
@@ -231,6 +231,7 @@ public void addConfig(OfferingConfigInterface configuration) {
 	public static class OfferingConfigInterface extends TableInterface {
 		private Set<String> iOperations;
 		private Long iConfigId;
+		private String iSchedulingDisclaimer;
 		
 		public Long getConfigId() { return iConfigId; }
 		public void setConfigId(Long configId) { iConfigId = configId; }
@@ -240,6 +241,10 @@ public void addOperation(String operation) {
 			if (iOperations == null) iOperations = new HashSet<String>();
 			iOperations.add(operation);
 		}
+		
+		public String getSchedulingDisclaimer() { return iSchedulingDisclaimer; }
+		public void setSchedulingDisclaimer(String schedulingDisclaimer) { iSchedulingDisclaimer = schedulingDisclaimer; }
+		public boolean hasSchedulingDisclaimer() { return iSchedulingDisclaimer != null && !iSchedulingDisclaimer.isEmpty(); }
 	}
 	
 	public static class SubpartDetailRequest implements GwtRpcRequest<SubpartDetailReponse> {
diff --git a/JavaSource/org/unitime/timetable/gwt/shared/ClassSetupInterface.java b/JavaSource/org/unitime/timetable/gwt/shared/ClassSetupInterface.java
@@ -66,6 +66,9 @@ public class ClassSetupInterface implements IsSerializable, Serializable, GwtRpc
 	private Boolean iHasTimeRooms;
 	private Boolean iHasInstructors;
 	
+	public String iSchedulingDisclaimer;
+	private Boolean iCanEditSchedulingDisclaimer;
+	
 	public static enum Operation implements IsSerializable, Serializable {
 		LOAD,
 		SAVE,
@@ -219,6 +222,12 @@ public int getSubpartIndex(Long id) {
 	public void setInstructionalMethodId(Long instructionalMethodId) { iInstructionalMethodId = instructionalMethodId; }
 	public Long getInstructionalMethodId() { return iInstructionalMethodId; }
 	
+	public String getSchedulingDisclaimer() { return iSchedulingDisclaimer; }
+	public void setSchedulingDisclaimer(String schedulingDisclaimer) { iSchedulingDisclaimer = schedulingDisclaimer; }
+	public boolean hasSchedulingDisclaimer() { return iSchedulingDisclaimer != null && !iSchedulingDisclaimer.isEmpty(); }
+	public boolean isCanEditSchedulingDisclaimer() { return iCanEditSchedulingDisclaimer != null && iCanEditSchedulingDisclaimer.booleanValue(); }
+	public void setCanEditSchedulingDisclaimer(boolean canEditSchedulingDisclaimer) { iCanEditSchedulingDisclaimer = canEditSchedulingDisclaimer; }
+	
 	protected boolean canCancelChildren(ClassLine line) {
 		if (line == null || !line.isEditable() || !line.isCanCancel()) return false;
 		boolean cancel = !line.getCancelled();
diff --git a/JavaSource/org/unitime/timetable/gwt/shared/InstrOfferingConfigInterface.java b/JavaSource/org/unitime/timetable/gwt/shared/InstrOfferingConfigInterface.java
@@ -64,6 +64,9 @@ public class InstrOfferingConfigInterface implements IsSerializable, Serializabl
 	private Boolean iCheckLimits;
 	private Integer iMaxNumberOfClasses;
 	private String iOp;
+	
+	public String iSchedulingDisclaimer;
+	private Boolean iCanEditSchedulingDisclaimer;
 
 	public static enum Operation implements IsSerializable, Serializable {
 		LOAD,
@@ -151,6 +154,12 @@ public SubpartLine copy(SubpartLine classLine) {
 	public void setOp(String op) { iOp = op; }
 	public String getOp() { return iOp; }
 	
+	public String getSchedulingDisclaimer() { return iSchedulingDisclaimer; }
+	public void setSchedulingDisclaimer(String schedulingDisclaimer) { iSchedulingDisclaimer = schedulingDisclaimer; }
+	public boolean hasSchedulingDisclaimer() { return iSchedulingDisclaimer != null && !iSchedulingDisclaimer.isEmpty(); }
+	public boolean isCanEditSchedulingDisclaimer() { return iCanEditSchedulingDisclaimer != null && iCanEditSchedulingDisclaimer.booleanValue(); }
+	public void setCanEditSchedulingDisclaimer(boolean canEditSchedulingDisclaimer) { iCanEditSchedulingDisclaimer = canEditSchedulingDisclaimer; }
+	
 	public void addDepartment(Long id, String ref, String label, boolean selectable) {
 		if (iDepartments == null) iDepartments = new ArrayList<Reference>();
 		iDepartments.add(new Reference(id, ref, label, selectable));
diff --git a/JavaSource/org/unitime/timetable/model/base/BaseInstrOfferingConfig.java b/JavaSource/org/unitime/timetable/model/base/BaseInstrOfferingConfig.java
@@ -55,6 +55,7 @@ public abstract class BaseInstrOfferingConfig implements Serializable {
 	private Boolean iUnlimitedEnrollment;
 	private String iName;
 	private Long iUniqueIdRolledForwardFrom;
+	private String iSchedulingDisclaimer;
 
 	private InstructionalOffering iInstructionalOffering;
 	private ClassDurationType iClassDurationType;
@@ -93,6 +94,10 @@ public BaseInstrOfferingConfig(Long uniqueId) {
 	public Long getUniqueIdRolledForwardFrom() { return iUniqueIdRolledForwardFrom; }
 	public void setUniqueIdRolledForwardFrom(Long uniqueIdRolledForwardFrom) { iUniqueIdRolledForwardFrom = uniqueIdRolledForwardFrom; }
 
+	@Column(name = "sched_disclaimer", nullable = true, length = 2000)
+	public String getSchedulingDisclaimer() { return iSchedulingDisclaimer; }
+	public void setSchedulingDisclaimer(String schedulingDisclaimer) { iSchedulingDisclaimer = schedulingDisclaimer; }
+
 	@ManyToOne(optional = false)
 	@JoinColumn(name = "instr_offr_id", nullable = false)
 	public InstructionalOffering getInstructionalOffering() { return iInstructionalOffering; }
@@ -146,6 +151,7 @@ public String toDebugString() {
 			"\n	InstructionalOffering: " + getInstructionalOffering() +
 			"\n	Limit: " + getLimit() +
 			"\n	Name: " + getName() +
+			"\n	SchedulingDisclaimer: " + getSchedulingDisclaimer() +
 			"\n	UniqueId: " + getUniqueId() +
 			"\n	UniqueIdRolledForwardFrom: " + getUniqueIdRolledForwardFrom() +
 			"\n	UnlimitedEnrollment: " + getUnlimitedEnrollment() +
diff --git a/JavaSource/org/unitime/timetable/security/permissions/CoursePermissions.java b/JavaSource/org/unitime/timetable/security/permissions/CoursePermissions.java
@@ -386,6 +386,9 @@ public boolean check(UserContext user, InstrOfferingConfig source) {
 		public Class<InstrOfferingConfig> type() { return InstrOfferingConfig.class; }
 	}
 	
+	@PermissionForRight(Right.InstrOfferingConfigEditDisclaimer)
+	public static class InstrOfferingConfigEditDisclaimer extends InstrOfferingConfigAdd {}
+	
 	@PermissionForRight(Right.InstrOfferingConfigAdd)
 	public static class InstrOfferingConfigAdd implements Permission<InstructionalOffering> {
 		@Autowired PermissionDepartment permissionDepartment;
diff --git a/JavaSource/org/unitime/timetable/security/rights/Right.java b/JavaSource/org/unitime/timetable/security/rights/Right.java
@@ -123,6 +123,7 @@ public enum Right {
 	InstrOfferingConfigEdit(InstrOfferingConfig.class),
 	InstrOfferingConfigEditDepartment(Department.class),
 	InstrOfferingConfigEditSubpart(SchedulingSubpart.class),
+	InstrOfferingConfigEditDisclaimer(InstructionalOffering.class),
 	InstrOfferingConfigDelete(InstrOfferingConfig.class),
 
 	MultipleClassSetup(InstrOfferingConfig.class),
diff --git a/JavaSource/org/unitime/timetable/server/courses/ClassSetupBackend.java b/JavaSource/org/unitime/timetable/server/courses/ClassSetupBackend.java
@@ -132,6 +132,8 @@ protected ClassSetupInterface load(ClassSetupInterface request, SessionContext c
 		form.setDisplayLms(Boolean.valueOf(LearningManagementSystemInfo.isLmsInfoDefinedForSession(context.getUser().getCurrentAcademicSessionId())));
 		form.setDisplaySnapshotLimit(io.getSnapshotLimitDate() != null);
 		form.setValidateLimits(ApplicationProperty.ConfigEditCheckLimits.isTrue());
+		form.setSchedulingDisclaimer(ioc.getSchedulingDisclaimer());
+		form.setCanEditSchedulingDisclaimer(context.hasPermission(io, Right.InstrOfferingConfigEditDisclaimer));
 		
 		String name = io.getCourseNameWithTitle();
         if (io.hasMultipleConfigurations()) {
@@ -296,6 +298,12 @@ protected ClassSetupInterface save(ClassSetupInterface form, SessionContext cont
 	        	hibSession.merge(ioc);
 	        }
 	        
+	        if (!ToolBox.equals(ioc.getSchedulingDisclaimer(), form.getSchedulingDisclaimer()) && context.hasPermission(ioc.getInstructionalOffering(), Right.InstrOfferingConfigEditDisclaimer)) {
+	        	ioc.setSchedulingDisclaimer(form.getSchedulingDisclaimer());
+	        	hibSession.merge(ioc);
+	        }
+
+	        
 	        // Get map of subpart ownership so that after the classes have changed it is possible to see if the ownership for a subparts has changed
 	        Map<Long, Department> origSubpartManagingDept = new HashMap<>();
         	for (SchedulingSubpart ss: ioc.getSchedulingSubparts())
diff --git a/JavaSource/org/unitime/timetable/server/courses/InstrOfferingConfigBackend.java b/JavaSource/org/unitime/timetable/server/courses/InstrOfferingConfigBackend.java
@@ -153,6 +153,9 @@ protected InstrOfferingConfigInterface load(InstrOfferingConfigInterface request
         form.setCheckLimits(ApplicationProperty.ConfigEditCheckLimits.isTrue());
         form.setMaxNumberOfClasses(ApplicationProperty.SubpartMaxNumClasses.intValue());
         
+        form.setSchedulingDisclaimer(ioc == null ? null : ioc.getSchedulingDisclaimer());
+        form.setCanEditSchedulingDisclaimer(context.hasPermission(io, Right.InstrOfferingConfigEditDisclaimer));
+        
         Department contrDept = io.getControllingCourseOffering().getSubjectArea().getDepartment();
         form.addDepartment(-1l, "-", MSG.subpartMultipleManagers(), false);
         form.addDepartment(contrDept.getUniqueId(), contrDept.getDeptCode(), MSG.dropDeptDepartment());
@@ -314,6 +317,9 @@ protected InstrOfferingConfigInterface save(InstrOfferingConfigInterface form, S
 	        	ioc.setClassDurationType(form.getDurationTypeId() == null || form.getDurationTypeId() < 0l ? null : ClassDurationTypeDAO.getInstance().get(form.getDurationTypeId(), hibSession));
 	        if (form.isInstructionalMethodEditable())
 	        	ioc.setInstructionalMethod(form.getInstructionalMethodId() == null || form.getInstructionalMethodId() < 0l ? null : InstructionalMethodDAO.getInstance().get(form.getInstructionalMethodId(), hibSession));
+
+	        if (context.hasPermission(io, Right.InstrOfferingConfigEditDisclaimer))
+	        	ioc.setSchedulingDisclaimer(form.getSchedulingDisclaimer());
 	        
 	        if (ioc.getUniqueId() == null)
 	        	hibSession.persist(ioc);
diff --git a/JavaSource/org/unitime/timetable/server/courses/InstructionalOfferingTableBuilder.java b/JavaSource/org/unitime/timetable/server/courses/InstructionalOfferingTableBuilder.java
diff --git a/WebContent/styles/unitime.css b/WebContent/styles/unitime.css

Original file line number	Diff line number	Diff line change
`@@ -6084,4 +6084,7 @@ public interface CourseMessages extends Messages {`
`6084`	`6084`
`6085`	`6085`	`@DefaultMessage("No Associated Course")`
`6086`	`6086`	`String itemNoParentCourse();`
	`6087`	`+`
	`6088`	`+ @DefaultMessage("Student Scheduling Disclaimer:")`
	`6089`	`+ String propertySchedulingDisclaimer();`
`6087`	`6090`	`}`