Coverage Report

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

Classes in this File

 package org.kuali.student.enrollment.courseoffering.infc;
 
 import org.kuali.student.r2.common.infc.IdEntity;
 import org.kuali.student.r2.common.infc.IdNamelessEntity;
 import org.kuali.student.r2.common.infc.RichText;
 
 import java.util.List;
 
 
 public interface CourseOfferingAdminDisplay extends IdNamelessEntity {
 
 
 
     /**
      * Custom Descr for the course Offering
      * @name Course Offering Description
      */
     public RichText getDescr();
 
     /**
      * A unique identifier assigned to all approved courses that exist
      * in the catalog This is not updatable once initialized.
      *
      * @name Course Id
      * @readOnly
      * @required
      * @impl this maps the the version dependent id as the offering
      *       must point to one and only one version of the
      *       course. Maps to cluId in Lui.
      */
     public String getCourseId();
 
 
     /**
      * Academic term of course offering
      *
      * @name Term Id
      * @readOnly
      * @required
      * @impl set during the #createCourseOffering and then maps to
      *       the aptKey on the Lui
      */
     public String getTermId();
 
 
     /**
      * 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
      */
     public String getCourseOfferingCode();
 
     /**
      * Identifies the department and/subject code of the course as reflected in
      * the course catalog. Initially copied from the course catalog but then,
      * depending on the configuration it may be updatable. In most
      * configurations this should not be updatable. Often used in the
      * calculation of the courseCode
      *
      * @name Subject Area
      * @readOnly
      */
     public String getSubjectArea();
 
     /**
      * 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 Title
      * @readOnly
     \ */
     public String getCourseOfferingTitle();
 
 
 
 
     /**
      * The name of the Type that the Course Offering or the underlying LUI
      * is of.
      *
      * @name Type name
      * @readOnly on updates
      * @impl Name of the type the CO Info is of, read from TypeInfo object
      */
     public String getTypeName();
 
     /**
      * The name of the State that the Course Offering or the underlying LUI
      * is in.
      *
      * @name State Name Owner
      * @readOnly on updates
      * @impl Name of the state the CO Info is in, read from StateInfo object
      */
     public String getStateName();
 
     /**
      * The display value of the credit, this is derived by fetching the result value groups for the credit option tied
      * to the course offering and concatenating the values of the options.
      *
      * @name Display Credit
      * @impl Get the credit option values and concatenate to a single field
      * @readOnly on updates
      */
     public String getDisplayCredit();
 
     /**
      * The display value of the grading options, this is derived by fetching the result value groups for the grading option tied
      * to the course offering and concatenating the values of the options.
      *
      * @name Display Grading
      * @impl Get the credit option values and concatenate to a single field
      * @readOnly on updates
      */
     public String getDisplayGrading();
 
     /**
      * Activty offering types for the course offering
      *
      * @name Actvity Offering Types
      * @impl Get the format offering for the course offering and then the activity types from the Format offering
      * @readOnly on updates
      */
     public List<String> getActivtyOfferingTypes();
 
     /**
      * Code for the term the course offering is in
      *
      * @name Term Code
      * @readOnly on updates
      */
     public String getTermCode();
 
 
 
     /**
      * Name of the Term the Course Offering is in
      *
      * @name Term Name
      * @readOnly on updates
      */
     public String getTermName();
 
 
 
 }

1		package org.kuali.student.enrollment.courseoffering.infc;
2
3		import org.kuali.student.r2.common.infc.IdEntity;
4		import org.kuali.student.r2.common.infc.IdNamelessEntity;
5		import org.kuali.student.r2.common.infc.RichText;
6
7		import java.util.List;
8
9
10		public interface CourseOfferingAdminDisplay extends IdNamelessEntity {
11
12
13
14		/**
15		* Custom Descr for the course Offering
16		* @name Course Offering Description
17		*/
18		public RichText getDescr();
19
20		/**
21		* A unique identifier assigned to all approved courses that exist
22		* in the catalog This is not updatable once initialized.
23		*
24		* @name Course Id
25		* @readOnly
26		* @required
27		* @impl this maps the the version dependent id as the offering
28		* must point to one and only one version of the
29		* course. Maps to cluId in Lui.
30		*/
31		public String getCourseId();
32
33
34		/**
35		* Academic term of course offering
36		*
37		* @name Term Id
38		* @readOnly
39		* @required
40		* @impl set during the #createCourseOffering and then maps to
41		* the aptKey on the Lui
42		*/
43		public String getTermId();
44
45
46		/**
47		* Identifies the number of a course as reflected in the course catalog.
48		* This typically must be unique across all courses offered during that
49		* term. If the user wants to create two separate offerings for the same
50		* course they must modify this code to make it unique. For example: An
51		* on-line offering of the course might have an "O" appended to it to
52		* distinguish it from the face to face offering, i.e. ENG101 and ENG101O
53		* Initially copied from the course catalog but then, depending on the
54		* configuration it may be updatable. Often this field is configured so that
55		* it is not not directly updatable but rather is calculated from it's two
56		* constituent parts, the subject area and the course number suffix. For
57		* example: Subject Area = "ENG" and Suffix = "101" then code = "ENG101"
58		*
59		* @name Course Offering Code
60		* @readOnly
61		*/
62		public String getCourseOfferingCode();
63
64		/**
65		* Identifies the department and/subject code of the course as reflected in
66		* the course catalog. Initially copied from the course catalog but then,
67		* depending on the configuration it may be updatable. In most
68		* configurations this should not be updatable. Often used in the
69		* calculation of the courseCode
70		*
71		* @name Subject Area
72		* @readOnly
73		*/
74		public String getSubjectArea();
75
76		/**
77		* Name of the course used in the college catalog. Initially copied from the
78		* course catalog but then, depending on the configuration it may be
79		* updatable. For regular courses this is not generally allowed to be
80		* updated on the offering, but for special topics courses this is often
81		* overridden to capture the particular topic being taught offered this
82		* term. Note: the configuration of the validation for titles is typically
83		* restricted to exclude line breaks. This may have to be loosened as some
84		* schools may want the particular topic to appear on a 2nd line. For
85		* example: SPECIAL TOPICS: AN EXPLORATION OF DEEP SPACE ARTIFACTS
86		*
87		* @name Course Title
88		* @readOnly
89		\ */
90		public String getCourseOfferingTitle();
91
92
93
94
95		/**
96		* The name of the Type that the Course Offering or the underlying LUI
97		* is of.
98		*
99		* @name Type name
100		* @readOnly on updates
101		* @impl Name of the type the CO Info is of, read from TypeInfo object
102		*/
103		public String getTypeName();
104
105		/**
106		* The name of the State that the Course Offering or the underlying LUI
107		* is in.
108		*
109		* @name State Name Owner
110		* @readOnly on updates
111		* @impl Name of the state the CO Info is in, read from StateInfo object
112		*/
113		public String getStateName();
114
115		/**
116		* The display value of the credit, this is derived by fetching the result value groups for the credit option tied
117		* to the course offering and concatenating the values of the options.
118		*
119		* @name Display Credit
120		* @impl Get the credit option values and concatenate to a single field
121		* @readOnly on updates
122		*/
123		public String getDisplayCredit();
124
125		/**
126		* The display value of the grading options, this is derived by fetching the result value groups for the grading option tied
127		* to the course offering and concatenating the values of the options.
128		*
129		* @name Display Grading
130		* @impl Get the credit option values and concatenate to a single field
131		* @readOnly on updates
132		*/
133		public String getDisplayGrading();
134
135		/**
136		* Activty offering types for the course offering
137		*
138		* @name Actvity Offering Types
139		* @impl Get the format offering for the course offering and then the activity types from the Format offering
140		* @readOnly on updates
141		*/
142		public List<String> getActivtyOfferingTypes();
143
144		/**
145		* Code for the term the course offering is in
146		*
147		* @name Term Code
148		* @readOnly on updates
149		*/
150		public String getTermCode();
151
152
153
154		/**
155		* Name of the Term the Course Offering is in
156		*
157		* @name Term Name
158		* @readOnly on updates
159		*/
160		public String getTermName();
161
162
163
164		}