001/**
002 * Copyright 2005-2016 The Kuali Foundation
003 *
004 * Licensed under the Educational Community License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 * http://www.opensource.org/licenses/ecl2.php
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016package org.kuali.rice.kim.api.identity.personal;
017
018import org.kuali.rice.core.api.mo.common.GloballyUnique;
019import org.kuali.rice.core.api.mo.common.Identifiable;
020import org.kuali.rice.core.api.mo.common.Versioned;
021
022/**
023 * ethnicity information for a KIM identity
024 * 
025 * @author Kuali Rice Team (kuali-rice@googlegroups.com)
026 *
027 */
028public interface EntityEthnicityContract extends Versioned, GloballyUnique, Identifiable {
029        
030        /**
031     * Gets this {@link EntityEthnicityContract}'s identity id.
032     * @return the identity id for this {@link EntityEthnicityContract}, or null if none has been assigned.
033     */
034        String getEntityId();
035        
036        /**
037     * Gets this {@link EntityEthnicityContract}'s ethnicity code.
038     * @return the ethnicity code for this {@link EntityEthnicityContract}, or null if none has been assigned.
039     */
040        String getEthnicityCode();
041        
042        /**
043     * Gets this {@link EntityEthnicityContract}'s unmasked ethnicity code.
044     * @return the unmasked ethnicity code for this {@link EntityEthnicityContract}, or null if none has been assigned.
045     */
046        String getEthnicityCodeUnmasked();
047        
048        /**
049     * Gets this {@link EntityEthnicityContract}'s sub-ethnicity code.
050     * @return the sub-ethnicity code for this {@link EntityEthnicityContract}, or null if none has been assigned.
051     */
052        String getSubEthnicityCode();
053        
054        /**
055     * Gets this {@link EntityEthnicityContract}'s unmasked sub-ethnicity code.
056     * @return the unmasked sub-ethnicity code for this {@link EntityEthnicityContract}, or null if none has been assigned.
057     */
058    String getSubEthnicityCodeUnmasked();
059
060    /**
061     * Returns a boolean value that determines if personal fields should be suppressed.
062     * @return boolean value that determines if personal fields should be suppressed.
063     */
064        boolean isSuppressPersonal();
065}