001/**
002 * Copyright 2005-2017 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.citizenship;
017
018import org.joda.time.DateTime;
019import org.kuali.rice.core.api.mo.common.GloballyUnique;
020import org.kuali.rice.core.api.mo.common.Identifiable;
021import org.kuali.rice.core.api.mo.common.Versioned;
022import org.kuali.rice.core.api.mo.common.active.Inactivatable;
023import org.kuali.rice.kim.api.identity.CodedAttributeContract;
024/**
025 * This contract represents the citizenship information  associated with an Entity.
026 *
027 * @author Kuali Rice Team (rice.collab@kuali.org)
028 */
029public interface EntityCitizenshipContract extends Versioned, GloballyUnique, Inactivatable, Identifiable {
030        /**
031     * Gets this id of the parent identity object.
032     * @return the identity id for this {@link EntityCitizenshipContract}
033     */
034    String getEntityId();
035
036    /**
037     * Gets this {@link EntityCitizenshipContract}'s citizenship status object.
038     * @return the Type object of citizenship status for this {@link EntityCitizenshipContract}, or null if none has been assigned.
039     */
040        CodedAttributeContract getStatus();
041
042        /**
043     * Gets this {@link EntityCitizenshipContract}'s country code.
044     * @return the country code for this {@link EntityCitizenshipContract}, or null if none has been assigned.
045     */
046        String getCountryCode();
047
048        /**
049     * Gets this {@link EntityCitizenshipContract}'s start date.
050     * @return the start date for this {@link EntityCitizenshipContract}, or null if none has been assigned.
051     */
052        DateTime getStartDate();
053
054        /**
055     * Gets this {@link EntityCitizenshipContract}'s end date.
056     * @return the end date for this {@link EntityCitizenshipContract}, or null if none has been assigned.
057     */
058        DateTime getEndDate();
059}