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.kim.api.identity.personal;
17
18 import org.kuali.rice.core.api.mo.common.GloballyUnique;
19 import org.kuali.rice.core.api.mo.common.Identifiable;
20 import org.kuali.rice.core.api.mo.common.Versioned;
21
22 /**
23 * ethnicity information for a KIM identity
24 *
25 * @author Kuali Rice Team (kuali-rice@googlegroups.com)
26 *
27 */
28 public interface EntityEthnicityContract extends Versioned, GloballyUnique, Identifiable {
29
30 /**
31 * Gets this {@link EntityEthnicityContract}'s identity id.
32 * @return the identity id for this {@link EntityEthnicityContract}, or null if none has been assigned.
33 */
34 String getEntityId();
35
36 /**
37 * Gets this {@link EntityEthnicityContract}'s ethnicity code.
38 * @return the ethnicity code for this {@link EntityEthnicityContract}, or null if none has been assigned.
39 */
40 String getEthnicityCode();
41
42 /**
43 * Gets this {@link EntityEthnicityContract}'s unmasked ethnicity code.
44 * @return the unmasked ethnicity code for this {@link EntityEthnicityContract}, or null if none has been assigned.
45 */
46 String getEthnicityCodeUnmasked();
47
48 /**
49 * Gets this {@link EntityEthnicityContract}'s sub-ethnicity code.
50 * @return the sub-ethnicity code for this {@link EntityEthnicityContract}, or null if none has been assigned.
51 */
52 String getSubEthnicityCode();
53
54 /**
55 * Gets this {@link EntityEthnicityContract}'s unmasked sub-ethnicity code.
56 * @return the unmasked sub-ethnicity code for this {@link EntityEthnicityContract}, or null if none has been assigned.
57 */
58 String getSubEthnicityCodeUnmasked();
59
60 /**
61 * Returns a boolean value that determines if personal fields should be suppressed.
62 * @return boolean value that determines if personal fields should be suppressed.
63 */
64 boolean isSuppressPersonal();
65 }