Coverage Report

Coverage Report - org.kuali.student.enrollment.academicrecord.infc.StudentCourseRecord

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.academicrecord.infc;
 
 import java.util.Date;
 
 import org.kuali.student.r2.common.infc.IdNamelessEntity;
 
 /**
  * Information about a Student Course Record. A Student Course Record
  * contains information on the courses a student has taken.
  *
  * include notes on Id
  *
  * @author tom
  * @since Tue Sep 06 14:22:34 EDT 2011
  */ 
 
 public interface StudentCourseRecord 
     extends IdNamelessEntity {
 
     /**
      *  The Source is represented by a Type to indicate what crated
      *  this record. Examples are "native" that implies the exietence
      *  of a Course Registration or a "transfer articulation" that may
      *  imply the existence of other data.
      *
      *  @name Source Type Key
      *  @readOnly
      */
     public String getSourceTypeKey();
 
     /**
      * The Id of the Course Registration. A Course Registration Id is
      * available for native source types.
      *
      * @name Course Registration Id
      * @readOnly
      * @required
      */
     public String getCourseRegistrationId();
 
     /**
      * The Id of the Student.
      *
      * @name Person Id
      * @readOnly
      * @required
      * @impl retrieved from the Course Registration
      */
     public String getPersonId();
 
     /**
      * The title of the course that was in effect at the time
      * the student took the course. 
      *
      * @name Course Title
      * @readOnly
      * @required
      * @impl retrieved from the CourseOffering related to the Course 
      *       Registration
      */
     public String getCourseTitle();
 
     /**
      * The code or number of the course that was in effect at the time
      * the student took the course. 
      *
      * @name Course Code
      * @readOnly
      * @required
      * @impl retrieved from the Registration Group related to the Course 
      *       Registration
      */
     public String getCourseCode();
 
     /**
      * The code or number of the primary activity or section that was
      * in effect at the time the student took the course.
      *
      * @name Activity Code
      * @readOnly
      * @required
      * @impl retrieved from the Course Offering related to the Course 
      *       Registration
      */
     public String getActivityCode();
 
     /**
      * The name of the term in which the student took the offering.
      *
      * @name Term Name
      * @readonly
      * @impl retrieved from the Term related to the Course Offering 
      *       in the Course Registration
      */
     public String getTermName();
 
     /**
      * The start date of the course.
      *
      * @name Course Begin Date
      * @readonly
      * @impl retrieved from the Term related to the Course Offering 
      *       in the Course Registration
      */
     public Date getCourseBeginDate();
 
     /**
      * The end date of the course.
      *
      * @name Course End Date
      * @readonly
      * @impl retrieved from the Term related to the Course Offering 
      *       in the Course Registration
      */
     public Date getCourseEndDate();
 
     /**
      * The grade the student was assigned for the course.
      *
      * @name Assigned Grade Value
      * @readonly
      */
     public String getAssignedGradeValue();
 
     /**
      * The Id for the grading scale for the assigned grade.
      *
      * @name Assigned Grade Scale Key
      * @readonly
      * @impl the Id of the Result Scale
      */
     public String getAssignedGradeScaleKey();
 
     /**
      * The grade the student was assigned for the course.
      *
      * @name Administrative Grade Value Key
      * @readonly
      */
     public String getAdministrativeGradeValue();
 
     /**
      * The Id for the grading scale for the administrative grade.
      *
      * @name Administrative Grade Scale Key
      * @readonly
      * @impl the Id of the Result Scale
      */
     public String getAdministrativeGradeScaleKey();
 
     /**
      * The calculated grade the student earned for the course.
      *
      * @name Calculated Grade Value
      * @readonly
      */
     public String getCalculatedGradeValue();
 
     /**
      * The Id for the grading scale for the calculated grade.
      *
      * @name Calculated Grade Scale Key
      * @readonly
      * @impl the Key of the Result Scale
      */
     public String getCalculatedGradeScaleKey();
 
     /**
      * The number of credits the student attempted for this course.
      *
      * @return a string representing a floating point decimal number
      * @name Credits Attempted
      * @required
      * @readonly
      */
     public String getCreditsAttempted();
 
     /**
      * The number of credits the student earned for this course.
      *
      * @return a string representing a floating point decimal number
      * @name Credits Earned
      * @readonly
      */
     public String getCreditsEarned();
 
     /**
      * The number of credits to be applied for the GPA calculation.
      * This is provides a weighting to this course for the GPA.
      *
      * @return a string representing a floating point decimal number
      * @name Credits For GPA
      */
     public String getCreditsForGPA();
 
     /**
      * If this student record counts toward the cumultive credits.
      *
      * @name Counts Toward Credits
      */
     public Boolean getCountsTowardCredits();
 
     /**
      * If this course is a repeat of a previous offering. the student
      * took.
      *
      * @name Is Repeated
      */
     public Boolean getIsRepeated();
 }

1		/**
2		* Copyright 2010 The Kuali Foundation Licensed under the
3		* Educational Community License, Version 2.0 (the "License"); you may
4		* not use this file except in compliance with the License. You may
5		* obtain a copy of the License at
6		*
7		* http://www.osedu.org/licenses/ECL-2.0
8		*
9		* Unless required by applicable law or agreed to in writing,
10		* software distributed under the License is distributed on an "AS IS"
11		* BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
12		* or implied. See the License for the specific language governing
13		* permissions and limitations under the License.
14		*/
15
16		package org.kuali.student.enrollment.academicrecord.infc;
17
18		import java.util.Date;
19
20		import org.kuali.student.r2.common.infc.IdNamelessEntity;
21
22		/**
23		* Information about a Student Course Record. A Student Course Record
24		* contains information on the courses a student has taken.
25		*
26		* include notes on Id
27		*
28		* @author tom
29		* @since Tue Sep 06 14:22:34 EDT 2011
30		*/
31
32		public interface StudentCourseRecord
33		extends IdNamelessEntity {
34
35		/**
36		* The Source is represented by a Type to indicate what crated
37		* this record. Examples are "native" that implies the exietence
38		* of a Course Registration or a "transfer articulation" that may
39		* imply the existence of other data.
40		*
41		* @name Source Type Key
42		* @readOnly
43		*/
44		public String getSourceTypeKey();
45
46		/**
47		* The Id of the Course Registration. A Course Registration Id is
48		* available for native source types.
49		*
50		* @name Course Registration Id
51		* @readOnly
52		* @required
53		*/
54		public String getCourseRegistrationId();
55
56		/**
57		* The Id of the Student.
58		*
59		* @name Person Id
60		* @readOnly
61		* @required
62		* @impl retrieved from the Course Registration
63		*/
64		public String getPersonId();
65
66		/**
67		* The title of the course that was in effect at the time
68		* the student took the course.
69		*
70		* @name Course Title
71		* @readOnly
72		* @required
73		* @impl retrieved from the CourseOffering related to the Course
74		* Registration
75		*/
76		public String getCourseTitle();
77
78		/**
79		* The code or number of the course that was in effect at the time
80		* the student took the course.
81		*
82		* @name Course Code
83		* @readOnly
84		* @required
85		* @impl retrieved from the Registration Group related to the Course
86		* Registration
87		*/
88		public String getCourseCode();
89
90		/**
91		* The code or number of the primary activity or section that was
92		* in effect at the time the student took the course.
93		*
94		* @name Activity Code
95		* @readOnly
96		* @required
97		* @impl retrieved from the Course Offering related to the Course
98		* Registration
99		*/
100		public String getActivityCode();
101
102		/**
103		* The name of the term in which the student took the offering.
104		*
105		* @name Term Name
106		* @readonly
107		* @impl retrieved from the Term related to the Course Offering
108		* in the Course Registration
109		*/
110		public String getTermName();
111
112		/**
113		* The start date of the course.
114		*
115		* @name Course Begin Date
116		* @readonly
117		* @impl retrieved from the Term related to the Course Offering
118		* in the Course Registration
119		*/
120		public Date getCourseBeginDate();
121
122		/**
123		* The end date of the course.
124		*
125		* @name Course End Date
126		* @readonly
127		* @impl retrieved from the Term related to the Course Offering
128		* in the Course Registration
129		*/
130		public Date getCourseEndDate();
131
132		/**
133		* The grade the student was assigned for the course.
134		*
135		* @name Assigned Grade Value
136		* @readonly
137		*/
138		public String getAssignedGradeValue();
139
140		/**
141		* The Id for the grading scale for the assigned grade.
142		*
143		* @name Assigned Grade Scale Key
144		* @readonly
145		* @impl the Id of the Result Scale
146		*/
147		public String getAssignedGradeScaleKey();
148
149		/**
150		* The grade the student was assigned for the course.
151		*
152		* @name Administrative Grade Value Key
153		* @readonly
154		*/
155		public String getAdministrativeGradeValue();
156
157		/**
158		* The Id for the grading scale for the administrative grade.
159		*
160		* @name Administrative Grade Scale Key
161		* @readonly
162		* @impl the Id of the Result Scale
163		*/
164		public String getAdministrativeGradeScaleKey();
165
166		/**
167		* The calculated grade the student earned for the course.
168		*
169		* @name Calculated Grade Value
170		* @readonly
171		*/
172		public String getCalculatedGradeValue();
173
174		/**
175		* The Id for the grading scale for the calculated grade.
176		*
177		* @name Calculated Grade Scale Key
178		* @readonly
179		* @impl the Key of the Result Scale
180		*/
181		public String getCalculatedGradeScaleKey();
182
183		/**
184		* The number of credits the student attempted for this course.
185		*
186		* @return a string representing a floating point decimal number
187		* @name Credits Attempted
188		* @required
189		* @readonly
190		*/
191		public String getCreditsAttempted();
192
193		/**
194		* The number of credits the student earned for this course.
195		*
196		* @return a string representing a floating point decimal number
197		* @name Credits Earned
198		* @readonly
199		*/
200		public String getCreditsEarned();
201
202		/**
203		* The number of credits to be applied for the GPA calculation.
204		* This is provides a weighting to this course for the GPA.
205		*
206		* @return a string representing a floating point decimal number
207		* @name Credits For GPA
208		*/
209		public String getCreditsForGPA();
210
211		/**
212		* If this student record counts toward the cumultive credits.
213		*
214		* @name Counts Toward Credits
215		*/
216		public Boolean getCountsTowardCredits();
217
218		/**
219		* If this course is a repeat of a previous offering. the student
220		* took.
221		*
222		* @name Is Repeated
223		*/
224		public Boolean getIsRepeated();
225		}