Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
CampusContract |
|
| 1.0;1 |
1 | /* | |
2 | * Copyright 2006-2011 The Kuali Foundation | |
3 | * | |
4 | * Licensed under the Educational Community License, Version 2.0 (the "License"); | |
5 | * you may not use this file except in compliance with the License. | |
6 | * You may obtain a copy of the License at | |
7 | * | |
8 | * http://www.opensource.org/licenses/ecl2.php | |
9 | * | |
10 | * Unless required by applicable law or agreed to in writing, software | |
11 | * distributed under the License is distributed on an "AS IS" BASIS, | |
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | |
13 | * See the License for the specific language governing permissions and | |
14 | * limitations under the License. | |
15 | */ | |
16 | ||
17 | package org.kuali.rice.shareddata.api.campus; | |
18 | ||
19 | import org.kuali.rice.core.api.mo.common.GloballyUnique; | |
20 | import org.kuali.rice.core.api.mo.common.Versioned; | |
21 | import org.kuali.rice.core.api.mo.common.active.Inactivatable; | |
22 | ||
23 | ||
24 | public interface CampusContract extends Versioned, GloballyUnique, Inactivatable { | |
25 | /** | |
26 | * This is the campus code for the Campus. This is cannot be a null or a blank string. | |
27 | * | |
28 | * <p> | |
29 | * It is a unique abreviation of a campus. | |
30 | * </p> | |
31 | * @return code for Campus. Will never be null or an empty string. | |
32 | */ | |
33 | String getCode(); | |
34 | ||
35 | /** | |
36 | * This is the name for the Campus. | |
37 | * | |
38 | * <p> | |
39 | * It is a name a campus. | |
40 | * </p> | |
41 | * @return name for Campus. | |
42 | */ | |
43 | String getName(); | |
44 | ||
45 | /** | |
46 | * This is the short name for the Campus. | |
47 | * | |
48 | * <p> | |
49 | * It is a shorter name for a campus. | |
50 | * </p> | |
51 | * @return short name for Campus. | |
52 | */ | |
53 | String getShortName(); | |
54 | ||
55 | /** | |
56 | * This is the campus type for the Campus. | |
57 | * | |
58 | * <p> | |
59 | * It is a object that defines the type of a campus. | |
60 | * </p> | |
61 | * @return short name for Campus. | |
62 | */ | |
63 | CampusTypeContract getCampusType(); | |
64 | ||
65 | /** | |
66 | * @return the active | |
67 | */ | |
68 | boolean isActive(); | |
69 | ||
70 | } |