1 /**
2 * Copyright 2005-2015 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.citizenship;
17
18 import org.joda.time.DateTime;
19 import org.kuali.rice.core.api.mo.common.GloballyUnique;
20 import org.kuali.rice.core.api.mo.common.Identifiable;
21 import org.kuali.rice.core.api.mo.common.Versioned;
22 import org.kuali.rice.core.api.mo.common.active.Inactivatable;
23 import org.kuali.rice.kim.api.identity.CodedAttributeContract;
24 /**
25 * This contract represents the citizenship information associated with an Entity.
26 *
27 * @author Kuali Rice Team (rice.collab@kuali.org)
28 */
29 public interface EntityCitizenshipContract extends Versioned, GloballyUnique, Inactivatable, Identifiable {
30 /**
31 * Gets this id of the parent identity object.
32 * @return the identity id for this {@link EntityCitizenshipContract}
33 */
34 String getEntityId();
35
36 /**
37 * Gets this {@link EntityCitizenshipContract}'s citizenship status object.
38 * @return the Type object of citizenship status for this {@link EntityCitizenshipContract}, or null if none has been assigned.
39 */
40 CodedAttributeContract getStatus();
41
42 /**
43 * Gets this {@link EntityCitizenshipContract}'s country code.
44 * @return the country code for this {@link EntityCitizenshipContract}, or null if none has been assigned.
45 */
46 String getCountryCode();
47
48 /**
49 * Gets this {@link EntityCitizenshipContract}'s start date.
50 * @return the start date for this {@link EntityCitizenshipContract}, or null if none has been assigned.
51 */
52 DateTime getStartDate();
53
54 /**
55 * Gets this {@link EntityCitizenshipContract}'s end date.
56 * @return the end date for this {@link EntityCitizenshipContract}, or null if none has been assigned.
57 */
58 DateTime getEndDate();
59 }