1 /**
2 * Copyright 2005-2014 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.kim.framework.identity.citizenship;
17
18 import org.kuali.rice.kim.api.identity.CodedAttributeContract;
19 import org.kuali.rice.krad.bo.ExternalizableBusinessObject;
20
21 /**
22 * TODO: Likely should remove all methods from this interface after KULRICE-7170 is fixed
23 */
24 public interface EntityCitizenshipStatusEbo extends CodedAttributeContract, ExternalizableBusinessObject {
25
26 /**
27 * This the name for the AddressType. This can be null or a blank string.
28 *
29 * @return the name of the AddressType
30 */
31 String getName();
32
33 /**
34 * This the sort code for the AddressType. This can be null or a blank string.
35 *
36 * @return the sort code of the AddressType
37 */
38 String getSortCode();
39
40 /**
41 * Returns the version number for this object. In general, this value should only
42 * be null if the object has not yet been stored to a persistent data store.
43 * This version number is generally used for the purposes of optimistic locking.
44 *
45 * @return the version number, or null if one has not been assigned yet
46 */
47 Long getVersionNumber();
48
49 /**
50 * Return the globally unique object id of this object. In general, this value should only
51 * be null if the object has not yet been stored to a persistent data store.
52 *
53 * @return the objectId of this object, or null if it has not been set yet
54 */
55 String getObjectId();
56
57 /**
58 * The active indicator for an object.
59 *
60 * @return true if active false if not.
61 */
62 boolean isActive();
63
64 /**
65 * The code value for this object. In general a code value cannot be null or a blank string.
66 *
67 * @return the code value for this object.
68 */
69 String getCode();
70 }