| Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
| State |
|
| 1.0;1 |
| 1 | /* | |
| 2 | * Copyright 2010 The Kuali Foundation | |
| 3 | * | |
| 4 | * Licensed under the Educational Community License, Version 2.0 (the | |
| 5 | * "License"); you may not use this file except in compliance with the | |
| 6 | * License. You may obtain a copy of the License at | |
| 7 | * | |
| 8 | * http://www.osedu.org/licenses/ECL-2.0 | |
| 9 | * | |
| 10 | * Unless required by applicable law or agreed to in writing, | |
| 11 | * software distributed under the License is distributed on an "AS IS" | |
| 12 | * BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express | |
| 13 | * or implied. See the License for the specific language governing | |
| 14 | * permissions and limitations under the License. | |
| 15 | */ | |
| 16 | ||
| 17 | package org.kuali.student.r2.core.state.infc; | |
| 18 | ||
| 19 | import org.kuali.student.r2.common.infc.HasAttributesAndMeta; | |
| 20 | import org.kuali.student.r2.common.infc.HasEffectiveDates; | |
| 21 | import org.kuali.student.r2.common.infc.HasKey; | |
| 22 | import org.kuali.student.r2.common.infc.RichText; | |
| 23 | ||
| 24 | ||
| 25 | /** | |
| 26 | * Describes the state of an object | |
| 27 | * | |
| 28 | * States are used in Kuali Student to decribe where the entity is | |
| 29 | * within a lifecycle. | |
| 30 | * | |
| 31 | * For example: A new course may be created in a "draft" state, then | |
| 32 | * move to a "submitted" state for review until it is finally | |
| 33 | * "approved". | |
| 34 | * | |
| 35 | * Most of validation of the the fields on the entity should be based | |
| 36 | * on state in combination with the entity's type. | |
| 37 | * | |
| 38 | * @author nwright | |
| 39 | */ | |
| 40 | ||
| 41 | public interface State | |
| 42 | extends HasKey, HasAttributesAndMeta, HasEffectiveDates { | |
| 43 | ||
| 44 | /** | |
| 45 | * Friendly name of the State. | |
| 46 | * | |
| 47 | * @name Name | |
| 48 | * @required | |
| 49 | */ | |
| 50 | public String getName(); | |
| 51 | ||
| 52 | /** | |
| 53 | * Narrative description of the State. | |
| 54 | * | |
| 55 | * @name Description | |
| 56 | */ | |
| 57 | public RichText getDescr(); | |
| 58 | ||
| 59 | /** | |
| 60 | * The Lifecycle key to which this State belongs. | |
| 61 | * | |
| 62 | * @name Lifecycle Key | |
| 63 | * @readOnly | |
| 64 | * @required | |
| 65 | */ | |
| 66 | public String getLifecycleKey(); | |
| 67 | } |