Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
KimEntityAddress |
|
| 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 | /** | |
19 | * address information for a KIM entity | |
20 | * | |
21 | * @author Kuali Rice Team (rice.collab@kuali.org) | |
22 | * | |
23 | */ | |
24 | public interface KimEntityAddress extends KimDefaultableEntityTypeData { | |
25 | ||
26 | /** | |
27 | * Gets this {@link KimEntityAddress}'s address id. | |
28 | * @return the address for this {@link KimEntityAddress}, or null if none has been assigned. | |
29 | */ | |
30 | String getEntityAddressId(); | |
31 | ||
32 | /** | |
33 | * Gets this {@link KimEntityAddress}'s address type code. | |
34 | * @return the address type code for this {@link KimEntityAddress}, or null if none has been assigned. | |
35 | */ | |
36 | String getAddressTypeCode(); | |
37 | ||
38 | /** | |
39 | * Gets this {@link KimEntityAddress}'s first line. | |
40 | * @return the first line for this {@link KimEntityAddress}, or null if none has been assigned. | |
41 | */ | |
42 | String getLine1(); | |
43 | ||
44 | /** | |
45 | * Gets this {@link KimEntityAddress}'s second line. | |
46 | * @return the second line for this {@link KimEntityAddress}, or null if none has been assigned. | |
47 | */ | |
48 | String getLine2(); | |
49 | ||
50 | /** | |
51 | * Gets this {@link KimEntityAddress}'s third line. | |
52 | * @return the third line for this {@link KimEntityAddress}, or null if none has been assigned. | |
53 | */ | |
54 | String getLine3(); | |
55 | ||
56 | /** | |
57 | * Gets this {@link KimEntityAddress}'s city name. | |
58 | * @return the city name for this {@link KimEntityAddress}, or null if none has been assigned. | |
59 | */ | |
60 | String getCityName(); | |
61 | ||
62 | /** | |
63 | * Gets this {@link KimEntityAddress}'s state code. | |
64 | * @return the state code for this {@link KimEntityAddress}, or null if none has been assigned. | |
65 | */ | |
66 | String getStateCode(); | |
67 | ||
68 | /** | |
69 | * Gets this {@link KimEntityAddress}'s postal code. | |
70 | * @return the postal code for this {@link KimEntityAddress}, or null if none has been assigned. | |
71 | */ | |
72 | String getPostalCode(); | |
73 | ||
74 | /** | |
75 | * Gets this {@link KimEntityAddress}'s country code. | |
76 | * @return the country code for this {@link KimEntityAddress}, or null if none has been assigned. | |
77 | */ | |
78 | String getCountryCode(); | |
79 | ||
80 | /** | |
81 | * Gets this {@link KimEntityAddress}'s unmasked first line. | |
82 | * @return the unmasked first line for this {@link KimEntityAddress}, or null if none has been assigned. | |
83 | */ | |
84 | String getLine1Unmasked(); | |
85 | ||
86 | /** | |
87 | * Gets this {@link KimEntityAddress}'s unmasked second line. | |
88 | * @return the unmasked second line for this {@link KimEntityAddress}, or null if none has been assigned. | |
89 | */ | |
90 | String getLine2Unmasked(); | |
91 | ||
92 | /** | |
93 | * Gets this {@link KimEntityAddress}'s unmasked third line. | |
94 | * @return the unmasked third line for this {@link KimEntityAddress}, or null if none has been assigned. | |
95 | */ | |
96 | String getLine3Unmasked(); | |
97 | ||
98 | /** | |
99 | * Gets this {@link KimEntityAddress}'s unmasked city name. | |
100 | * @return the unmasked city name for this {@link KimEntityAddress}, or null if none has been assigned. | |
101 | */ | |
102 | String getCityNameUnmasked(); | |
103 | ||
104 | /** | |
105 | * Gets this {@link KimEntityAddress}'s unmasked state code. | |
106 | * @return the unmasked state code for this {@link KimEntityAddress}, or null if none has been assigned. | |
107 | */ | |
108 | String getStateCodeUnmasked(); | |
109 | ||
110 | /** | |
111 | * Gets this {@link KimEntityAddress}'s unmasked postal code. | |
112 | * @return the unmasked postal code for this {@link KimEntityAddress}, or null if none has been assigned. | |
113 | */ | |
114 | String getPostalCodeUnmasked(); | |
115 | ||
116 | /** | |
117 | * Gets this {@link KimEntityAddress}'s unmasked country code. | |
118 | * @return the unmasked country code for this {@link KimEntityAddress}, or null if none has been assigned. | |
119 | */ | |
120 | String getCountryCodeUnmasked(); | |
121 | ||
122 | boolean isSuppressAddress(); | |
123 | } |