Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
KimEntityPhone |
|
| 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 | * phone information for a KIM entity | |
20 | * | |
21 | * @author Kuali Rice Team (rice.collab@kuali.org) | |
22 | * | |
23 | */ | |
24 | public interface KimEntityPhone extends KimDefaultableEntityTypeData { | |
25 | ||
26 | /** | |
27 | * Gets this {@link KimEntityPhone}'s id. | |
28 | * @return the id for this {@link KimEntityPhone}, or null if none has been assigned. | |
29 | */ | |
30 | String getEntityPhoneId(); | |
31 | ||
32 | /** | |
33 | * Gets this {@link KimEntityPhone}'s type code. | |
34 | * @return the type code for this {@link KimEntityPhone}, or null if none has been assigned. | |
35 | */ | |
36 | String getPhoneTypeCode(); | |
37 | ||
38 | /** | |
39 | * Gets this {@link KimEntityPhone}'s phone number. | |
40 | * @return the phone number for this {@link KimEntityPhone}, or null if none has been assigned. | |
41 | */ | |
42 | String getPhoneNumber(); | |
43 | ||
44 | /** | |
45 | * Gets this {@link KimEntityPhone}'s extension number. | |
46 | * @return the extension number for this {@link KimEntityPhone}, or null if none has been assigned. | |
47 | */ | |
48 | String getExtensionNumber(); | |
49 | ||
50 | /** | |
51 | * Gets this {@link KimEntityPhone}'s country code. | |
52 | * @return the country code for this {@link KimEntityPhone}, or null if none has been assigned. | |
53 | */ | |
54 | String getCountryCode(); | |
55 | ||
56 | /** | |
57 | * Gets this {@link KimEntityPhone}'s unmasked phone number. | |
58 | * @return the unmasked phone number for this {@link KimEntityPhone}, or null if none has been assigned. | |
59 | */ | |
60 | String getPhoneNumberUnmasked(); | |
61 | ||
62 | /** | |
63 | * Gets this {@link KimEntityPhone}'s unmasked extension number. | |
64 | * @return the unmasked extension number for this {@link KimEntityPhone}, or null if none has been assigned. | |
65 | */ | |
66 | String getExtensionNumberUnmasked(); | |
67 | ||
68 | /** | |
69 | * Gets this {@link KimEntityPhone}'s unmasked country code. | |
70 | * @return the unmasked country code for this {@link KimEntityPhone}, or null if none has been assigned. | |
71 | */ | |
72 | String getCountryCodeUnmasked(); | |
73 | ||
74 | /** | |
75 | * Gets this {@link KimEntityPhone}'s formatted phone number. | |
76 | * @return the formatted phone number for this {@link KimEntityPhone}, or null if none has been assigned. | |
77 | */ | |
78 | String getFormattedPhoneNumber(); | |
79 | ||
80 | /** | |
81 | * Gets this {@link KimEntityPhone}'s unmasked formatted phone number. | |
82 | * @return the unmasked formatted phone number for this {@link KimEntityPhone}, or null if none has been assigned. | |
83 | */ | |
84 | String getFormattedPhoneNumberUnmasked(); | |
85 | ||
86 | boolean isSuppressPhone(); | |
87 | } |