1 /*
2 * Copyright 2007-2009 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.bo.entity;
17
18
19 /**
20 * ethnicity information for a KIM entity
21 *
22 * @author Kuali Rice Team (kuali-rice@googlegroups.com)
23 *
24 */
25 public interface KimEntityEthnicity {
26
27 /**
28 * Gets this {@link KimEntityEthnicity}'s id.
29 * @return the id for this {@link KimEntityEthnicity}, or null if none has been assigned.
30 */
31 String getId();
32
33 /**
34 * Gets this {@link KimEntityEthnicity}'s entity id.
35 * @return the entity id for this {@link KimEntityEthnicity}, or null if none has been assigned.
36 */
37 String getEntityId();
38
39 /**
40 * Gets this {@link KimEntityEthnicity}'s ethnicity code.
41 * @return the ethnicity code for this {@link KimEntityEthnicity}, or null if none has been assigned.
42 */
43 String getEthnicityCode();
44
45 /**
46 * Gets this {@link KimEntityEthnicity}'s unmasked ethnicity code.
47 * @return the unmasked ethnicity code for this {@link KimEntityEthnicity}, or null if none has been assigned.
48 */
49 String getEthnicityCodeUnmasked();
50
51 /**
52 * Gets this {@link KimEntityEthnicity}'s sub-ethnicity code.
53 * @return the sub-ethnicity code for this {@link KimEntityEthnicity}, or null if none has been assigned.
54 */
55 String getSubEthnicityCode();
56
57 /**
58 * Gets this {@link KimEntityEthnicity}'s unmasked sub-ethnicity code.
59 * @return the unmasked sub-ethnicity code for this {@link KimEntityEthnicity}, or null if none has been assigned.
60 */
61 String getSubEthnicityCodeUnmasked();
62
63 boolean isSuppressPersonal();
64 }