| Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
| Exemption |
|
| 1.0;1 |
| 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.r2.core.exemption.infc; | |
| 17 | ||
| 18 | import org.kuali.student.r2.common.infc.IdEntity; | |
| 19 | import java.util.Date; | |
| 20 | ||
| 21 | ||
| 22 | /** | |
| 23 | * Information about an Exemption. The qualifier, if it exists, | |
| 24 | * qualifies the restriction exemption to a scope, such as for a | |
| 25 | * particular Course or Program. | |
| 26 | * | |
| 27 | * There can only be one override structure per exemption. The | |
| 28 | * override structure available in this Exmeption is constrained by | |
| 29 | * the Exemption Type. | |
| 30 | * | |
| 31 | * org? | |
| 32 | * | |
| 33 | * @author tom | |
| 34 | * @since Tue Jun 14 14:22:34 EDT 2011 | |
| 35 | */ | |
| 36 | public interface Exemption extends IdEntity { | |
| 37 | ||
| 38 | /** | |
| 39 | * The Id of the Exemption Request. | |
| 40 | * | |
| 41 | * @name Exemption Request Id | |
| 42 | */ | |
| 43 | public String getExemptionRequestId(); | |
| 44 | ||
| 45 | /** | |
| 46 | * The key of a Process that indicates to what Process in the | |
| 47 | * the exemption is applied. | |
| 48 | * | |
| 49 | * @name Process Key | |
| 50 | * @required | |
| 51 | */ | |
| 52 | public String getProcessKey(); | |
| 53 | ||
| 54 | /** | |
| 55 | * The Id of a Check that indicates to what Check in the Process | |
| 56 | * the exemption is applied. | |
| 57 | * | |
| 58 | * @name Check Id | |
| 59 | */ | |
| 60 | public String getCheckKey(); | |
| 61 | ||
| 62 | ||
| 63 | /** | |
| 64 | * The Id of the Person who was exempted. | |
| 65 | * | |
| 66 | * @name Person Id | |
| 67 | */ | |
| 68 | public String getPersonId(); | |
| 69 | ||
| 70 | /** | |
| 71 | * The date this exemption becomes effective. | |
| 72 | * | |
| 73 | * @name Effective Date | |
| 74 | */ | |
| 75 | public Date getEffectiveDate(); | |
| 76 | ||
| 77 | /** | |
| 78 | * The date this exemption expires. | |
| 79 | * | |
| 80 | * @name Expiration Date | |
| 81 | */ | |
| 82 | public Date getExpirationDate(); | |
| 83 | ||
| 84 | /** | |
| 85 | * The number of times this Exemption may be used. | |
| 86 | * | |
| 87 | * @name Use Limit | |
| 88 | */ | |
| 89 | public Integer getUseLimit(); | |
| 90 | ||
| 91 | /** | |
| 92 | * The number of times this Exemption was marked as used. | |
| 93 | * | |
| 94 | * @name Use Count | |
| 95 | */ | |
| 96 | public Integer getUseCount(); | |
| 97 | ||
| 98 | /** | |
| 99 | * The data for a date override. | |
| 100 | * | |
| 101 | * @name Date Override | |
| 102 | */ | |
| 103 | public DateOverride getDateOverride(); | |
| 104 | ||
| 105 | /** | |
| 106 | * The data for a milestone override. | |
| 107 | * | |
| 108 | * @name Milestone Override | |
| 109 | */ | |
| 110 | public MilestoneOverride getMilestoneOverride(); | |
| 111 | ||
| 112 | /** | |
| 113 | * The data for a learning result override. | |
| 114 | * | |
| 115 | * @name Learning Result Override | |
| 116 | */ | |
| 117 | public LearningResultOverride getLearningResultOverride(); | |
| 118 | } |