1 /**
2 * Copyright 2005-2012 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 package org.kuali.rice.location.framework.campus;
17
18 import org.kuali.rice.core.api.mo.common.active.MutableInactivatable;
19 import org.kuali.rice.krad.bo.ExternalizableBusinessObject;
20 import org.kuali.rice.location.api.campus.CampusContract;
21 import org.kuali.rice.location.api.campus.CampusTypeContract;
22
23 /**
24 * TODO: Likely should remove all methods from this interface after KULRICE-7170 is fixed
25 */
26 public interface CampusEbo extends CampusContract, ExternalizableBusinessObject, MutableInactivatable {
27
28 /**
29 * This is the name for the Campus.
30 *
31 * <p>
32 * It is a name a campus.
33 * </p>
34 *
35 * @return name for Campus.
36 */
37 String getName();
38
39 /**
40 * This is the short name for the Campus.
41 *
42 * <p>
43 * It is a shorter name for a campus.
44 * </p>
45 *
46 * @return short name for Campus.
47 */
48 String getShortName();
49
50 /**
51 * This is the campus type for the Campus.
52 *
53 * <p>
54 * It is a object that defines the type of a campus.
55 * </p>
56 *
57 * @return short name for Campus.
58 */
59 CampusTypeContract getCampusType();
60
61 /**
62 * The code value for this object. In general a code value cannot be null or a blank string.
63 *
64 * @return the code value for this object.
65 */
66 String getCode();
67
68 /**
69 * Returns the version number for this object. In general, this value should only
70 * be null if the object has not yet been stored to a persistent data store.
71 * This version number is generally used for the purposes of optimistic locking.
72 *
73 * @return the version number, or null if one has not been assigned yet
74 */
75 Long getVersionNumber();
76
77 /**
78 * Return the globally unique object id of this object. In general, this value should only
79 * be null if the object has not yet been stored to a persistent data store.
80 *
81 * @return the objectId of this object, or null if it has not been set yet
82 */
83 String getObjectId();
84
85 /**
86 * The active indicator for an object.
87 *
88 * @return true if active false if not.
89 */
90 boolean isActive();
91
92 /**
93 * Sets the record to active or inactive.
94 */
95 void setActive(boolean active);
96 }