| Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
| KimEntityBioDemographics |
|
| 1.0;1 |
| 1 | /* | |
| 2 | * Copyright 2007-2008 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.bo.entity; | |
| 17 | ||
| 18 | import java.util.Date; | |
| 19 | ||
| 20 | /** | |
| 21 | * demographic information for a KIM entity | |
| 22 | * | |
| 23 | * @author Kuali Rice Team (rice.collab@kuali.org) | |
| 24 | * | |
| 25 | */ | |
| 26 | public interface KimEntityBioDemographics { | |
| 27 | ||
| 28 | /** | |
| 29 | * Gets this {@link KimEntityBioDemographics}'s entity id. | |
| 30 | * @return the entity id for this {@link KimEntityBioDemographics}, or null if none has been assigned. | |
| 31 | */ | |
| 32 | String getEntityId(); | |
| 33 | ||
| 34 | /** | |
| 35 | * Gets this {@link KimEntityBioDemographics}'s deceased date. | |
| 36 | * @return the deceased date for this {@link KimEntityBioDemographics}, or null if none has been assigned. | |
| 37 | */ | |
| 38 | Date getDeceasedDate(); | |
| 39 | ||
| 40 | /** | |
| 41 | * Gets this {@link KimEntityBioDemographics}'s birth date. | |
| 42 | * @return the birth date for this {@link KimEntityBioDemographics}, or null if none has been assigned. | |
| 43 | */ | |
| 44 | Date getBirthDate(); | |
| 45 | ||
| 46 | /** | |
| 47 | * Gets this {@link KimEntityBioDemographics}'s gender code. | |
| 48 | * @return the gender code for this {@link KimEntityBioDemographics}, or null if none has been assigned. | |
| 49 | */ | |
| 50 | String getGenderCode(); | |
| 51 | ||
| 52 | /** | |
| 53 | * Gets this {@link KimEntityBioDemographics}'s marital status code. | |
| 54 | * @return the marital status code for this {@link KimEntityBioDemographics}, or null if none has been assigned. | |
| 55 | */ | |
| 56 | String getMaritalStatusCode(); | |
| 57 | ||
| 58 | /** | |
| 59 | * Gets this {@link KimEntityBioDemographics}'s primary language code. | |
| 60 | * @return the primary language code for this {@link KimEntityBioDemographics}, or null if none has been assigned. | |
| 61 | */ | |
| 62 | String getPrimaryLanguageCode(); | |
| 63 | ||
| 64 | /** | |
| 65 | * Gets this {@link KimEntityBioDemographics}'s secondary language code. | |
| 66 | * @return the secondary language code for this {@link KimEntityBioDemographics}, or null if none has been assigned. | |
| 67 | */ | |
| 68 | String getSecondaryLanguageCode(); | |
| 69 | ||
| 70 | /** | |
| 71 | * Gets this {@link KimEntityBioDemographics}'s country of birth code. | |
| 72 | * @return the country of birth code for this {@link KimEntityBioDemographics}, or null if none has been assigned. | |
| 73 | */ | |
| 74 | String getCountryOfBirthCode(); | |
| 75 | ||
| 76 | /** | |
| 77 | * Gets this {@link KimEntityBioDemographics}'s birth state code. | |
| 78 | * @return the birth state code for this {@link KimEntityBioDemographics}, or null if none has been assigned. | |
| 79 | */ | |
| 80 | String getBirthStateCode(); | |
| 81 | ||
| 82 | /** | |
| 83 | * Gets this {@link KimEntityBioDemographics}'s city of birth. | |
| 84 | * @return the city of birth for this {@link KimEntityBioDemographics}, or null if none has been assigned. | |
| 85 | */ | |
| 86 | String getCityOfBirth(); | |
| 87 | ||
| 88 | /** | |
| 89 | * Gets this {@link KimEntityBioDemographics}'s geographic origin. | |
| 90 | * @return the geographic origin for this {@link KimEntityBioDemographics}, or null if none has been assigned. | |
| 91 | */ | |
| 92 | String getGeographicOrigin(); | |
| 93 | ||
| 94 | /** | |
| 95 | * Gets this {@link KimEntityBioDemographics}'s unmasked birth date. | |
| 96 | * @return the unmasked birth date for this {@link KimEntityBioDemographics}, or null if none has been assigned. | |
| 97 | */ | |
| 98 | Date getBirthDateUnmasked(); | |
| 99 | ||
| 100 | /** | |
| 101 | * Gets this {@link KimEntityBioDemographics}'s unmasked gender code. | |
| 102 | * @return the unmasked gender code for this {@link KimEntityBioDemographics}, or null if none has been assigned. | |
| 103 | */ | |
| 104 | String getGenderCodeUnmasked(); | |
| 105 | ||
| 106 | /** | |
| 107 | * Gets this {@link KimEntityBioDemographics}'s unmasked martial status code. | |
| 108 | * @return the unmasked martial status code for this {@link KimEntityBioDemographics}, or null if none has been assigned. | |
| 109 | */ | |
| 110 | String getMaritalStatusCodeUnmasked(); | |
| 111 | ||
| 112 | /** | |
| 113 | * Gets this {@link KimEntityBioDemographics}'s unmasked primary language code. | |
| 114 | * @return the unmasked primary language code for this {@link KimEntityBioDemographics}, or null if none has been assigned. | |
| 115 | */ | |
| 116 | String getPrimaryLanguageCodeUnmasked(); | |
| 117 | ||
| 118 | /** | |
| 119 | * Gets this {@link KimEntityBioDemographics}'s unmasked secondary language code. | |
| 120 | * @return the unmasked secondary language code for this {@link KimEntityBioDemographics}, or null if none has been assigned. | |
| 121 | */ | |
| 122 | String getSecondaryLanguageCodeUnmasked(); | |
| 123 | ||
| 124 | /** | |
| 125 | * Gets this {@link KimEntityBioDemographics}'s unmasked country of birth code. | |
| 126 | * @return the unmasked country of birth code for this {@link KimEntityBioDemographics}, or null if none has been assigned. | |
| 127 | */ | |
| 128 | String getCountryOfBirthCodeUnmasked(); | |
| 129 | ||
| 130 | /** | |
| 131 | * Gets this {@link KimEntityBioDemographics}'s unmaksed birth state code. | |
| 132 | * @return the unmaksed birth state code for this {@link KimEntityBioDemographics}, or null if none has been assigned. | |
| 133 | */ | |
| 134 | String getBirthStateCodeUnmasked(); | |
| 135 | ||
| 136 | /** | |
| 137 | * Gets this {@link KimEntityBioDemographics}'s unmasked city of birth. | |
| 138 | * @return the unmasked city of birth for this {@link KimEntityBioDemographics}, or null if none has been assigned. | |
| 139 | */ | |
| 140 | String getCityOfBirthUnmasked(); | |
| 141 | ||
| 142 | /** | |
| 143 | * Gets this {@link KimEntityBioDemographics}'s unmasked geographic origin. | |
| 144 | * @return the unmasked geographic origin for this {@link KimEntityBioDemographics}, or null if none has been assigned. | |
| 145 | */ | |
| 146 | String getGeographicOriginUnmasked(); | |
| 147 | ||
| 148 | boolean isSuppressPersonal(); | |
| 149 | ||
| 150 | } |