| Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
| Check |
|
| 1.0;1 |
| 1 | /** | |
| 2 | * Copyright 2011 The Kuali Foundation Licensed under the Educational | |
| 3 | * Community License, Version 2.0 (the "License"); you may not use | |
| 4 | * this file except in compliance with the License. You may obtain a | |
| 5 | * 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, software | |
| 10 | * distributed under the License is distributed on an "AS IS" BASIS, | |
| 11 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or | |
| 12 | * 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.process.infc; | |
| 17 | ||
| 18 | import org.kuali.student.r2.common.infc.KeyEntity; | |
| 19 | ||
| 20 | ||
| 21 | /** | |
| 22 | * Information about a Check. A Check can be one of a: | |
| 23 | * | |
| 24 | * 1. Hold Check: the Issue Id is not null | |
| 25 | * 2. Deadline Check: the Milestone Type Key and Atp Type Key are | |
| 26 | * not null | |
| 27 | * 3. Not Before Check: the Milestone Type Key and Atp Type Key are | |
| 28 | * not null | |
| 29 | * 4. In Time Period Check: the Milestone Type Key and Atp Type | |
| 30 | * Key are not null | |
| 31 | * 5. Outside Date Range Check: the Milestone Type Key and Atp | |
| 32 | * Type Key are not null | |
| 33 | * 6. Statement Check: the Statement Id is not null | |
| 34 | * 7. Process Check: the Process key is not null | |
| 35 | * | |
| 36 | * @author tom | |
| 37 | * @since Thu Nov 21 14:22:34 EDT 2011 | |
| 38 | */ | |
| 39 | ||
| 40 | public interface Check | |
| 41 | extends KeyEntity { | |
| 42 | ||
| 43 | /** | |
| 44 | * The Issue Key if this Check is for a Hold. | |
| 45 | * | |
| 46 | * @name Issue Key | |
| 47 | */ | |
| 48 | public String getIssueId(); | |
| 49 | ||
| 50 | /** | |
| 51 | * The Milestone Type Key if this Check is for a deadline, "not | |
| 52 | * before," "in time period" or "outside date range" checks. | |
| 53 | * | |
| 54 | * @name Milestone Type Key | |
| 55 | */ | |
| 56 | public String getMilestoneTypeKey(); | |
| 57 | ||
| 58 | /** | |
| 59 | * The Agenda Id if this Check is based on evaluating | |
| 60 | * an Agenda. (do we need a reference for the eval?) | |
| 61 | * | |
| 62 | * @name Agenda Id | |
| 63 | */ | |
| 64 | public String getAgendaId(); | |
| 65 | ||
| 66 | /** | |
| 67 | * The Process Key if this Check is based on evaluating | |
| 68 | * a Process. | |
| 69 | * | |
| 70 | * @name Process Key | |
| 71 | */ | |
| 72 | public String getProcessKey(); | |
| 73 | } |