Coverage Report

Coverage Report - org.kuali.student.r2.core.exemption.infc.ExemptionRequest

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.r2.core.exemption.infc;
 
 import java.util.Date;
 import org.kuali.student.r2.common.infc.IdEntity;
 
 /**
  * Information about an ExemptionRequest. 
  *
  * The qualifier, if it exists, qualifies the restriction exemption to
  * a scope, such as for a particular Program.
  *
  * There can only be one override structure per exemption request. The
  * override structure available in this ExmeptionRequest is
  * constrained by the ExemptionRequest Type.  What about populations
  * such as all athletes, or some other group of people?
  *
  * @author tom
  * @since Tue Jun 14 14:22:34 EDT 2011
  */
 public interface ExemptionRequest extends IdEntity {
 
     /**
      * The id of a Process that indicates to what Process in the
      * the exemption is requested, if any.
      *
      * @name Process id
      */
     public String getProcessId();
 
     /**
      * The Id of a Check that indicates to what Check in the Process
      * the exemption is requested, if any.
      *
      * @name Check Id
      */
     public String getCheckKey();
 
     /**
      * The Id of the Person for whom the request is requested
      *
      * @name Person Id
      * @required
      * @readOnly on update
      */
     public String getPersonId();
 
     /**
      * The Id of the Person making the request.
      * 
      * If not specified it should default to the person identified in the supplied
      * context.
      *
      * @name Requester Id
      */
     public String getRequesterId();
 
     /**
      * The date of this exemption request.
      * 
      * If not specified it should default to today's date.
      *
      * @name Request Date
      * @required
      */
     public Date getRequestDate();
 
     /**
      * The Id of the Person who approved this request.
      *
      * @name Approved By Person Id
      */
     public String getApprovedByPersonId();
 
     /**
      * The date this request was approved.
      *
      * @name Approved Date
      */
     public Date getApprovedDate();
 
     /**
      * The detailed data for a date override.
      *
      * @name Date Override
      */
     public DateOverride getDateOverride();
 
     /**
      * The data for a milestone override.
      *
      * TODO: understand the exact usage of this.
      * 
      * @name Milestone Override
      */
     public MilestoneOverride getMilestoneOverride();
 
     /**
      * The data for a learning result override.
      * 
      * This is deprecated because it is just a PLACEHOLDER for eventual overrides 
      * that are used in degree audit.
      * 
      * @name Learning Result Override
      */
     @Deprecated
     public LearningResultOverride getLearningResultOverride();
 }

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		package org.kuali.student.r2.core.exemption.infc;
16
17		import java.util.Date;
18		import org.kuali.student.r2.common.infc.IdEntity;
19
20		/**
21		* Information about an ExemptionRequest.
22		*
23		* The qualifier, if it exists, qualifies the restriction exemption to
24		* a scope, such as for a particular Program.
25		*
26		* There can only be one override structure per exemption request. The
27		* override structure available in this ExmeptionRequest is
28		* constrained by the ExemptionRequest Type. What about populations
29		* such as all athletes, or some other group of people?
30		*
31		* @author tom
32		* @since Tue Jun 14 14:22:34 EDT 2011
33		*/
34		public interface ExemptionRequest extends IdEntity {
35
36		/**
37		* The id of a Process that indicates to what Process in the
38		* the exemption is requested, if any.
39		*
40		* @name Process id
41		*/
42		public String getProcessId();
43
44		/**
45		* The Id of a Check that indicates to what Check in the Process
46		* the exemption is requested, if any.
47		*
48		* @name Check Id
49		*/
50		public String getCheckKey();
51
52		/**
53		* The Id of the Person for whom the request is requested
54		*
55		* @name Person Id
56		* @required
57		* @readOnly on update
58		*/
59		public String getPersonId();
60
61		/**
62		* The Id of the Person making the request.
63		*
64		* If not specified it should default to the person identified in the supplied
65		* context.
66		*
67		* @name Requester Id
68		*/
69		public String getRequesterId();
70
71		/**
72		* The date of this exemption request.
73		*
74		* If not specified it should default to today's date.
75		*
76		* @name Request Date
77		* @required
78		*/
79		public Date getRequestDate();
80
81		/**
82		* The Id of the Person who approved this request.
83		*
84		* @name Approved By Person Id
85		*/
86		public String getApprovedByPersonId();
87
88		/**
89		* The date this request was approved.
90		*
91		* @name Approved Date
92		*/
93		public Date getApprovedDate();
94
95		/**
96		* The detailed data for a date override.
97		*
98		* @name Date Override
99		*/
100		public DateOverride getDateOverride();
101
102		/**
103		* The data for a milestone override.
104		*
105		* TODO: understand the exact usage of this.
106		*
107		* @name Milestone Override
108		*/
109		public MilestoneOverride getMilestoneOverride();
110
111		/**
112		* The data for a learning result override.
113		*
114		* This is deprecated because it is just a PLACEHOLDER for eventual overrides
115		* that are used in degree audit.
116		*
117		* @name Learning Result Override
118		*/
119		@Deprecated
120		public LearningResultOverride getLearningResultOverride();
121		}