Coverage Report

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

Classes in this File

 /*
  * Copyright 2012 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 org.kuali.student.r2.common.infc.IdEntity;
 
 /**
  * An adminsitrative view of the ActivityOffering.
  *
  * @author tom
  */
 public interface ActivityOfferingAdminDisplay
     extends IdEntity {
 
     /**
      * A display name for the Activity Offering Type.
      *
      * @name Activity Offering Type Display Name
      * @readOnly
      * @impl ActivityOffering.Type.Name
      */
     public String getTypeName();
 
     /**
      * A display name for the activity Offering State.
      *
      * @name Activity Offering State Display Name
      * @readOnly
      * @impl ActivityOffering.State.Name
      */
     public String getStateName();
 
     /**
      * Name of the course used in the college catalog. Initially
      * copied from the course catalog but then, depending on the
      * configuration it may be updatable. For regular courses this is
      * not generally allowed to be updated on the offering, but for
      * special topics courses this is often overridden to capture the
      * particular topic being taught offered this term. Note: the
      * configuration of the validation for titles is typically
      * restricted to exclude line breaks. This may have to be loosened
      * as some schools may want the particular topic to appear on a
      * 2nd line. For example: SPECIAL TOPICS: AN EXPLORATION OF DEEP
      * SPACE ARTIFACTS
      * 
      * @name Course Offering Title
      * @readOnly
      * @impl ActivityOffering.FormatOffering.CourseOffering.Title
      */
     public String getCourseOfferingTitle();
 
     /**
      * Identifies the number of a course as reflected in the course
      * catalog.  This typically must be unique across all courses
      * offered during that term. If the user wants to create two
      * separate offerings for the same course they must modify this
      * code to make it unique. For example: An on-line offering of the
      * course might have an "O" appended to it to distinguish it from
      * the face to face offering, i.e. ENG101 and ENG101O Initially
      * copied from the course catalog but then, depending on the
      * configuration it may be updatable. Often this field is
      * configured so that it is not not directly updatable but rather
      * is calculated from it's two constituent parts, the subject area
      * and the course number suffix. For example: Subject Area = "ENG"
      * and Suffix = "101" then code = "ENG101"
      * 
      * @name Course Offering Code
      * @readOnly
      * @impl ActivityOffering.FormatOffering.CourseOffering.CourseOfferingCode
      */
     public String getCourseOfferingCode();
 
     /**
      * The Format Offering Id used to create this ActivityOffering.
      *
      * @name Format Offering Id
      * @readOnly
      * @impl ActivityOffering.FormatOffering.Id
      */
     public String getFormatOfferingId();
 
     /**
      * A display name for the Format Offering.
      *
      * @name Format Offering Display Name
      * @readOnly
      * @impl ActivityOffering.FormatOffering.Name
      */
     public String getFormatOfferingName();
 
     /**
      * Alphanumeric character that identifies the section of the
      * course offering.
      *
      * @name Activity Offering Code
      * @readOnly
      * @impl ActivityOffering.ActivityOfferingCode
      */
     public String getActivityOfferingCode();
 
     /**
      * Gets the instructor of record for this ActivityOffering.
      *
      * @name Instructor Id
      * @readOnly
      * @impl ActivityOffering.OfferingInstructor.PersonId
      */
     public String getInstructorId();
 
     /**
      * Gets the iname of the nstructor of record for this
      * ActivityOffering.
      *
      * @name Instructor Display Name
      * @readOnly
      * @impl ActivityOffering.OfferingInstructor.Person.name
      */
     public String getInstructorName();
 
     /**
      * Gets a display string represnting the weekday pattern using
      * characters.
      *
      * @name Schedule Display Weekdays
      * @readOnly
      * @impl if unscheduled, this string is built from all of related
      *       ScheduleRequest.ScheduleComponents.TimeSlots.Weekdays If
      *       there is more than one related ScheduleRequest, then use
      *       the most recent active one (the one that will be sent to
      *       the scheduler).
      *
      *       if scheduled, then use
      *       ActivityOffering.Schedule.ScheduleComponents.TimeSlots.Weekdays
      */
     public String getScheduleWeekdays();
 
     /**
      * Gets a display string represnting the time and duration.
      *
      * @name Schedule Display Time
      * @readOnly
      * @impl if unscheduled, this string is built from all of related
      *       ScheduleRequest.ScheduleComponents.TimeSlots.StartTime
      *       and ScheduleRequest.ScheduleComponents.TimeSlots.Duration
      *       and If there is more than one related ScheduleRequest,
      *       then use the most recent active one (the one that will be
      *       sent to the scheduler).
      *
      *       if scheduled, then use
      *       ActivityOffering.Schedule.ScheduleComponents.TimeSlots.StartTime
      *       and
      *       ActivityOffering.Schedule.ScheduleComponents.TimeSlots.Duration
      */
     public String getScheduleTime();
 }

1		/*
2		* Copyright 2012 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
17		package org.kuali.student.enrollment.courseoffering.infc;
18
19		import org.kuali.student.r2.common.infc.IdEntity;
20
21		/**
22		* An adminsitrative view of the ActivityOffering.
23		*
24		* @author tom
25		*/
26		public interface ActivityOfferingAdminDisplay
27		extends IdEntity {
28
29		/**
30		* A display name for the Activity Offering Type.
31		*
32		* @name Activity Offering Type Display Name
33		* @readOnly
34		* @impl ActivityOffering.Type.Name
35		*/
36		public String getTypeName();
37
38		/**
39		* A display name for the activity Offering State.
40		*
41		* @name Activity Offering State Display Name
42		* @readOnly
43		* @impl ActivityOffering.State.Name
44		*/
45		public String getStateName();
46
47		/**
48		* Name of the course used in the college catalog. Initially
49		* copied from the course catalog but then, depending on the
50		* configuration it may be updatable. For regular courses this is
51		* not generally allowed to be updated on the offering, but for
52		* special topics courses this is often overridden to capture the
53		* particular topic being taught offered this term. Note: the
54		* configuration of the validation for titles is typically
55		* restricted to exclude line breaks. This may have to be loosened
56		* as some schools may want the particular topic to appear on a
57		* 2nd line. For example: SPECIAL TOPICS: AN EXPLORATION OF DEEP
58		* SPACE ARTIFACTS
59		*
60		* @name Course Offering Title
61		* @readOnly
62		* @impl ActivityOffering.FormatOffering.CourseOffering.Title
63		*/
64		public String getCourseOfferingTitle();
65
66		/**
67		* Identifies the number of a course as reflected in the course
68		* catalog. This typically must be unique across all courses
69		* offered during that term. If the user wants to create two
70		* separate offerings for the same course they must modify this
71		* code to make it unique. For example: An on-line offering of the
72		* course might have an "O" appended to it to distinguish it from
73		* the face to face offering, i.e. ENG101 and ENG101O Initially
74		* copied from the course catalog but then, depending on the
75		* configuration it may be updatable. Often this field is
76		* configured so that it is not not directly updatable but rather
77		* is calculated from it's two constituent parts, the subject area
78		* and the course number suffix. For example: Subject Area = "ENG"
79		* and Suffix = "101" then code = "ENG101"
80		*
81		* @name Course Offering Code
82		* @readOnly
83		* @impl ActivityOffering.FormatOffering.CourseOffering.CourseOfferingCode
84		*/
85		public String getCourseOfferingCode();
86
87		/**
88		* The Format Offering Id used to create this ActivityOffering.
89		*
90		* @name Format Offering Id
91		* @readOnly
92		* @impl ActivityOffering.FormatOffering.Id
93		*/
94		public String getFormatOfferingId();
95
96		/**
97		* A display name for the Format Offering.
98		*
99		* @name Format Offering Display Name
100		* @readOnly
101		* @impl ActivityOffering.FormatOffering.Name
102		*/
103		public String getFormatOfferingName();
104
105		/**
106		* Alphanumeric character that identifies the section of the
107		* course offering.
108		*
109		* @name Activity Offering Code
110		* @readOnly
111		* @impl ActivityOffering.ActivityOfferingCode
112		*/
113		public String getActivityOfferingCode();
114
115		/**
116		* Gets the instructor of record for this ActivityOffering.
117		*
118		* @name Instructor Id
119		* @readOnly
120		* @impl ActivityOffering.OfferingInstructor.PersonId
121		*/
122		public String getInstructorId();
123
124		/**
125		* Gets the iname of the nstructor of record for this
126		* ActivityOffering.
127		*
128		* @name Instructor Display Name
129		* @readOnly
130		* @impl ActivityOffering.OfferingInstructor.Person.name
131		*/
132		public String getInstructorName();
133
134		/**
135		* Gets a display string represnting the weekday pattern using
136		* characters.
137		*
138		* @name Schedule Display Weekdays
139		* @readOnly
140		* @impl if unscheduled, this string is built from all of related
141		* ScheduleRequest.ScheduleComponents.TimeSlots.Weekdays If
142		* there is more than one related ScheduleRequest, then use
143		* the most recent active one (the one that will be sent to
144		* the scheduler).
145		*
146		* if scheduled, then use
147		* ActivityOffering.Schedule.ScheduleComponents.TimeSlots.Weekdays
148		*/
149		public String getScheduleWeekdays();
150
151		/**
152		* Gets a display string represnting the time and duration.
153		*
154		* @name Schedule Display Time
155		* @readOnly
156		* @impl if unscheduled, this string is built from all of related
157		* ScheduleRequest.ScheduleComponents.TimeSlots.StartTime
158		* and ScheduleRequest.ScheduleComponents.TimeSlots.Duration
159		* and If there is more than one related ScheduleRequest,
160		* then use the most recent active one (the one that will be
161		* sent to the scheduler).
162		*
163		* if scheduled, then use
164		* ActivityOffering.Schedule.ScheduleComponents.TimeSlots.StartTime
165		* and
166		* ActivityOffering.Schedule.ScheduleComponents.TimeSlots.Duration
167		*/
168		public String getScheduleTime();
169		}