Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
Entity |
|
| 1.0;1 |
1 | /** | |
2 | * Copyright 2010 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.common.infc; | |
17 | ||
18 | import org.kuali.student.r2.common.dto.RichTextInfo; | |
19 | ||
20 | ||
21 | /** | |
22 | * A common interface pattern for service entities. | |
23 | * | |
24 | * @author tom | |
25 | * @Since Tue Apr 05 14:22:34 EDT 2011 | |
26 | */ | |
27 | ||
28 | public interface Entity | |
29 | extends HasPrimaryKey, | |
30 | HasType, | |
31 | HasState, | |
32 | HasAttributesAndMeta { | |
33 | ||
34 | /** | |
35 | * Name: Name | |
36 | * A display name for this entity. | |
37 | * | |
38 | * @return the entity name | |
39 | */ | |
40 | ||
41 | public String getName(); | |
42 | ||
43 | ||
44 | /** | |
45 | * Name: Description | |
46 | * A description of the entity. | |
47 | * | |
48 | * @return the entity description | |
49 | */ | |
50 | ||
51 | public RichTextInfo getDescr(); | |
52 | } |