001    /*
002     * Copyright 2007-2008 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     */
016    package org.kuali.rice.kim.bo.entity;
017    
018    import java.util.Date;
019    
020    import org.kuali.rice.kns.bo.Inactivateable;
021    
022    /**
023     * citizenship information for a KIM entity
024     * 
025     * @author Kuali Rice Team (rice.collab@kuali.org)
026     */
027    public interface KimEntityCitizenship extends Inactivateable {
028    
029        /**
030         * Gets this {@link KimEntityCitizenship}'s id.
031         * @return the id for this {@link KimEntityCitizenship}, or null if none has been assigned.
032         */
033            String getEntityCitizenshipId();
034            
035            /**
036         * Gets this {@link KimEntityCitizenship}'s citizenship status code.
037         * @return the citizenship status code for this {@link KimEntityCitizenship}, or null if none has been assigned.
038         */
039            String getCitizenshipStatusCode();
040            
041            /**
042         * Gets this {@link KimEntityCitizenship}'s country code.
043         * @return the country code for this {@link KimEntityCitizenship}, or null if none has been assigned.
044         */
045            String getCountryCode();
046            
047            /**
048         * Gets this {@link KimEntityCitizenship}'s start date.
049         * @return the start date for this {@link KimEntityCitizenship}, or null if none has been assigned.
050         */
051            Date getStartDate();
052            
053            /**
054         * Gets this {@link KimEntityCitizenship}'s end date.
055         * @return the end date for this {@link KimEntityCitizenship}, or null if none has been assigned.
056         */
057            Date getEndDate();
058    }