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.state;
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.state.StateContract;
21
22 /**
23 * TODO: Likely should remove all methods from this interface after KULRICE-7170 is fixed
24 */
25 public interface StateEbo extends StateContract, ExternalizableBusinessObject, MutableInactivatable {
26
27 /**
28 * The code value for this object. In general a code value cannot be null or a blank string.
29 *
30 * @return the code value for this object.
31 */
32 String getCode();
33
34 /**
35 * This the postal name for the State. This cannot be null or a blank string.
36 *
37 * @return postal name
38 */
39 String getName();
40
41 /**
42 * This the postal country code for the State. This cannot be null or a blank string.
43 *
44 * @return postal country code
45 */
46 String getCountryCode();
47
48 /**
49 * The active indicator for an object.
50 *
51 * @return true if active false if not.
52 */
53 boolean isActive();
54
55 /**
56 * Sets the record to active or inactive.
57 */
58 void setActive(boolean active);
59
60 /**
61 * Returns the version number for this object. In general, this value should only
62 * be null if the object has not yet been stored to a persistent data store.
63 * This version number is generally used for the purposes of optimistic locking.
64 *
65 * @return the version number, or null if one has not been assigned yet
66 */
67 Long getVersionNumber();
68 }