Coverage Report

Coverage Report - org.kuali.student.enrollment.courseoffering.infc.ActivityOffering

Classes in this File

 /*
  * Copyright 2010 The Kuali Foundation 
  *
  * Licensed under the Educational Community 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.osedu.org/licenses/ECL-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.
  */
 package org.kuali.student.enrollment.courseoffering.infc;
 
 import java.util.Date;
 import java.util.List;
 
 import org.kuali.student.r2.common.infc.IdEntity;
 import org.kuali.student.r2.common.infc.IdNamelessEntity;
 
 /**
  * Individual activity offerings correspond to events in a scheduling
  * system, each with a meeting pattern.
  *
  * @author Kamal
  */
 public interface ActivityOffering extends IdEntity {
 
     /**
      * Format offering Id used to create this activity
      *
      * @name Format Offering Id
      * @required
      * @readonly
      */
     public String getFormatOfferingId();
 
     /**
      * Format offering Name used to create this activity
      *
      * @name Format Offering Name
      * @required
      * @readonly
      */
     public String getFormatOfferingName();
 
     /**
      * Canonical activity whose instance is this activity offering.
      *
      * @name Activity Id
      * @required
      * @readonly
      */
     public String getActivityId();
 
     /**
      * Academic term the activity is being offered in. 
      * 
      * Same as course offering term or a nested term of course
      * offering.
      * 
      * @name Term Id
      * @required
      * @readonly
      * @impl map to Lui.getAtpId
      */
     public String getTermId();
 
     /**
      * Academic term code the activity is being offered in.
      *
      * Same as course offering term or a nested term of course
      * offering.
      *
      * @name Term Code
      * @required
      * @readonly
      * @impl map to Lui.getAtpCode
      */
     public String getTermCode();
 
     /**
      * Alphanumeric character that identifies the section of the
      * course offering.
      *
      * @name Activity Code
      */
     public String getActivityCode();
 
     /**
      * Gets the schedule Id for this offering.
      *
      * @name Schedule Id
      * @impl maps to Scheduling service not implemented
      */
     public String getScheduleId();
 
     /**
      * Indicates that the course is an Honors Course.
      *
      * @name Is Honors Offering
      * @required
      */
     public Boolean getIsHonorsOffering();
 
     /**
      * The options/scales that indicate the allowable grades that can
      * be awarded.  If the value is set here then the canonical course
      * must have a grading option set on the canonical activity.
      * 
      * @name Grading Option Keys
      * @impl maps to Lui.gradingOptions
      */
     public List<String> getGradingOptionKeys();
 
     /**
      * Instructors for the activity. This list should be constrained
      * by the instructors listed on the course offering.
      *
      * @name Instructors
      * @impl maps to Lui.instructors
      */
     public List<? extends OfferingInstructor> getInstructors();
 
     /**
      * Course Offering id the activity is being offered in.
      *
      * @name Course Offering Id
      * @required
      * @readonly
      * @impl maps to the containing formatOffering's courseOfferingId
      */
     public String getCourseOfferingId();
 
     /**
      * Course Offering code the activity is being offered in.
      *
      * @name Course Offering Code
      * @required
      * @readonly
      * @impl maps to the containing formatOffering's courseOffering's code
      */
     public String getCourseOfferingCode();
 
     /**
      * Course Offering title the activity is being offered in.
      *
      * @name Course Offering Title
      * @required
      * @readonly
      * @impl maps to the containing formatOffering's courseOffering's title
      */
     public String getCourseOfferingTitle();
 
     /********************** Final Exam Information ******************/
     /**
      * Start time of final exam
      * @name Final Exam StartTime
      */
     public Date getFinalExamStartTime();
 
     /**
      * End time of final exam.
      * @name Final Exam EndTime
      */
     public Date getFinalExamEndTime();
 
     /**
      * Space code where final exam will be conducted
      * @name Final Exam Space Code
      */
     public String getFinalExamSpaceCode();
 
     /********************* Delivery Logistics **********************/
     /**
      * When/for how long does the offering meet in class.  Calculated
      * by system based on meeting times; may be validated against
      * canonical.  The unit is hours.
      *
      * @name Weekly Inclass Contact Hours
      */
     public String getWeeklyInclassContactHours();
 
     /**
      * When/for how long does the offering meet out of class.  Entered
      * by Scheduler. The unit is hours.
      *
      * @name Weekly Outofclass Contact Hours
      */
     public String getWeeklyOutofclassContactHours();
 
     /**
      * When/for how long does the offering meet in total.  Calculated
      * by system based as sum of In Class and Out of Class hours.  The
      * unit is hours.
      *
      * @name Weekly Total Contac Hours
      */
     public String getWeeklyTotalContactHours();
 
     /**
      * Total maximum number of "seats" or enrollment slots that can be
      * filled for the offering.
      *
      * @name Maximum Enrollment
      * @impl maps to Lui.maximumEnrollment
      */
     public Integer getMaximumEnrollment();
 
     /** 
      * Total minimum number of seats that must be filled for the
      * offering not to be canceled.
      *
      * @name Minimum  Enrollment
      * @impl maps to Lui.minimumEnrollment
      */
     public Integer getMinimumEnrollment();
 
     /**
      * Is maximum enrollment estimate flag
      *
      * @name Is Maximum Enrollment Estimate Flag
      */
     public Boolean getIsMaxEnrollmentEstimate();
 
     /**
      * Is there an instructor evaluation for this activity offering.
      *
      * @name Instructor Evaluation Flag
      */
     public Boolean getIsEvaluated();
 
     /**
      * Gets the URL for this offering.
      *
      * @name Activity Offering URL
      */
     public String getActivityOfferingURL();
 }

1		/*
2		* Copyright 2010 The Kuali Foundation
3		*
4		* Licensed under the Educational Community License, Version 2.0 (the
5		* "License"); you may not use this file except in compliance with the
6		* License. You may obtain a copy of the License at
7		*
8		* http://www.osedu.org/licenses/ECL-2.0
9		*
10		* Unless required by applicable law or agreed to in writing, software
11		* distributed under the License is distributed on an "AS IS" BASIS,
12		* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
13		* implied. See the License for the specific language governing
14		* permissions and limitations under the License.
15		*/
16		package org.kuali.student.enrollment.courseoffering.infc;
17
18		import java.util.Date;
19		import java.util.List;
20
21		import org.kuali.student.r2.common.infc.IdEntity;
22		import org.kuali.student.r2.common.infc.IdNamelessEntity;
23
24		/**
25		* Individual activity offerings correspond to events in a scheduling
26		* system, each with a meeting pattern.
27		*
28		* @author Kamal
29		*/
30		public interface ActivityOffering extends IdEntity {
31
32		/**
33		* Format offering Id used to create this activity
34		*
35		* @name Format Offering Id
36		* @required
37		* @readonly
38		*/
39		public String getFormatOfferingId();
40
41		/**
42		* Format offering Name used to create this activity
43		*
44		* @name Format Offering Name
45		* @required
46		* @readonly
47		*/
48		public String getFormatOfferingName();
49
50		/**
51		* Canonical activity whose instance is this activity offering.
52		*
53		* @name Activity Id
54		* @required
55		* @readonly
56		*/
57		public String getActivityId();
58
59		/**
60		* Academic term the activity is being offered in.
61		*
62		* Same as course offering term or a nested term of course
63		* offering.
64		*
65		* @name Term Id
66		* @required
67		* @readonly
68		* @impl map to Lui.getAtpId
69		*/
70		public String getTermId();
71
72		/**
73		* Academic term code the activity is being offered in.
74		*
75		* Same as course offering term or a nested term of course
76		* offering.
77		*
78		* @name Term Code
79		* @required
80		* @readonly
81		* @impl map to Lui.getAtpCode
82		*/
83		public String getTermCode();
84
85		/**
86		* Alphanumeric character that identifies the section of the
87		* course offering.
88		*
89		* @name Activity Code
90		*/
91		public String getActivityCode();
92
93		/**
94		* Gets the schedule Id for this offering.
95		*
96		* @name Schedule Id
97		* @impl maps to Scheduling service not implemented
98		*/
99		public String getScheduleId();
100
101		/**
102		* Indicates that the course is an Honors Course.
103		*
104		* @name Is Honors Offering
105		* @required
106		*/
107		public Boolean getIsHonorsOffering();
108
109		/**
110		* The options/scales that indicate the allowable grades that can
111		* be awarded. If the value is set here then the canonical course
112		* must have a grading option set on the canonical activity.
113		*
114		* @name Grading Option Keys
115		* @impl maps to Lui.gradingOptions
116		*/
117		public List<String> getGradingOptionKeys();
118
119		/**
120		* Instructors for the activity. This list should be constrained
121		* by the instructors listed on the course offering.
122		*
123		* @name Instructors
124		* @impl maps to Lui.instructors
125		*/
126		public List<? extends OfferingInstructor> getInstructors();
127
128		/**
129		* Course Offering id the activity is being offered in.
130		*
131		* @name Course Offering Id
132		* @required
133		* @readonly
134		* @impl maps to the containing formatOffering's courseOfferingId
135		*/
136		public String getCourseOfferingId();
137
138		/**
139		* Course Offering code the activity is being offered in.
140		*
141		* @name Course Offering Code
142		* @required
143		* @readonly
144		* @impl maps to the containing formatOffering's courseOffering's code
145		*/
146		public String getCourseOfferingCode();
147
148		/**
149		* Course Offering title the activity is being offered in.
150		*
151		* @name Course Offering Title
152		* @required
153		* @readonly
154		* @impl maps to the containing formatOffering's courseOffering's title
155		*/
156		public String getCourseOfferingTitle();
157
158		/******************** Final Exam Information ****************/
159		/**
160		* Start time of final exam
161		* @name Final Exam StartTime
162		*/
163		public Date getFinalExamStartTime();
164
165		/**
166		* End time of final exam.
167		* @name Final Exam EndTime
168		*/
169		public Date getFinalExamEndTime();
170
171		/**
172		* Space code where final exam will be conducted
173		* @name Final Exam Space Code
174		*/
175		public String getFinalExamSpaceCode();
176
177		/******************* Delivery Logistics ********************/
178		/**
179		* When/for how long does the offering meet in class. Calculated
180		* by system based on meeting times; may be validated against
181		* canonical. The unit is hours.
182		*
183		* @name Weekly Inclass Contact Hours
184		*/
185		public String getWeeklyInclassContactHours();
186
187		/**
188		* When/for how long does the offering meet out of class. Entered
189		* by Scheduler. The unit is hours.
190		*
191		* @name Weekly Outofclass Contact Hours
192		*/
193		public String getWeeklyOutofclassContactHours();
194
195		/**
196		* When/for how long does the offering meet in total. Calculated
197		* by system based as sum of In Class and Out of Class hours. The
198		* unit is hours.
199		*
200		* @name Weekly Total Contac Hours
201		*/
202		public String getWeeklyTotalContactHours();
203
204		/**
205		* Total maximum number of "seats" or enrollment slots that can be
206		* filled for the offering.
207		*
208		* @name Maximum Enrollment
209		* @impl maps to Lui.maximumEnrollment
210		*/
211		public Integer getMaximumEnrollment();
212
213		/**
214		* Total minimum number of seats that must be filled for the
215		* offering not to be canceled.
216		*
217		* @name Minimum Enrollment
218		* @impl maps to Lui.minimumEnrollment
219		*/
220		public Integer getMinimumEnrollment();
221
222		/**
223		* Is maximum enrollment estimate flag
224		*
225		* @name Is Maximum Enrollment Estimate Flag
226		*/
227		public Boolean getIsMaxEnrollmentEstimate();
228
229		/**
230		* Is there an instructor evaluation for this activity offering.
231		*
232		* @name Instructor Evaluation Flag
233		*/
234		public Boolean getIsEvaluated();
235
236		/**
237		* Gets the URL for this offering.
238		*
239		* @name Activity Offering URL
240		*/
241		public String getActivityOfferingURL();
242		}