Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
StateProcess |
|
| 1.0;1 |
1 | /* | |
2 | * Copyright 2011 The Kuali Foundation Licensed under the Educational Community License, Version 2.0 (the "License"); you may | |
3 | * not use this file except in compliance with the License. You may obtain a copy of the License at | |
4 | * http://www.osedu.org/licenses/ECL-2.0 Unless required by applicable law or agreed to in writing, software distributed | |
5 | * under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or | |
6 | * implied. See the License for the specific language governing permissions and limitations under the License. | |
7 | */ | |
8 | package org.kuali.student.r2.common.infc; | |
9 | ||
10 | ||
11 | /** | |
12 | * Detailed Information about a State Process | |
13 | * | |
14 | * State Process are used in Kuali Student to define various process keys that might be associated with objectTypes | |
15 | * For example: A course might have a lifecycle process or workflow process with different states in each process | |
16 | * | |
17 | * | |
18 | * @author Kuali Student Team (Kamal) | |
19 | * | |
20 | */ | |
21 | public interface StateProcess extends HasKey, HasAttributes, HasEffectiveDates { | |
22 | ||
23 | /** | |
24 | * Friendly name of the State Process | |
25 | * @name Name | |
26 | * @readOnly | |
27 | * @required | |
28 | */ | |
29 | public String getName(); | |
30 | ||
31 | ||
32 | /** | |
33 | * Narrative description of the State Process | |
34 | * @name Description | |
35 | * @readOnly | |
36 | */ | |
37 | public RichText getDescr(); | |
38 | ||
39 | } |