1 /**
2 * Copyright 2005-2013 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.phone;
17
18 import org.kuali.rice.core.api.mo.common.Defaultable;
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 is a contract for EntityPhone and represents the
26 * phone information of an Entity.
27 *
28 * @author Kuali Rice Team (rice.collab@kuali.org)
29 */
30
31 public interface EntityPhoneContract extends Versioned, GloballyUnique, Defaultable, Inactivatable, Identifiable {
32
33 /**
34 * Gets this id of the parent identity object.
35 * @return the identity id for this {@link EntityPhoneContract}
36 */
37 String getEntityId();
38
39 /**
40 * Gets this entityTypeCode of the {@link EntityPhoneContract}'s object.
41 * @return the identity type code for this {@link EntityPhoneContract}
42 */
43 String getEntityTypeCode();
44
45 /**
46 * Gets this {@link EntityPhone}'s type code.
47 * @return the type code for this {@link EntityPhone}, or null if none has been assigned.
48 */
49 CodedAttributeContract getPhoneType();
50
51 /**
52 * Gets this {@link EntityPhone}'s phone number.
53 * @return the phone number for this {@link EntityPhone}, or null if none has been assigned.
54 */
55 String getPhoneNumber();
56
57 /**
58 * Gets this {@link EntityPhone}'s extension number.
59 * @return the extension number for this {@link EntityPhone}, or null if none has been assigned.
60 */
61 String getExtensionNumber();
62
63 /**
64 * Gets this {@link EntityPhone}'s country code.
65 * @return the country code for this {@link EntityPhone}, or null if none has been assigned.
66 */
67 String getCountryCode();
68
69 /**
70 * Gets this {@link EntityPhone}'s unmasked phone number.
71 * @return the unmasked phone number for this {@link EntityPhone}, or null if none has been assigned.
72 */
73 String getPhoneNumberUnmasked();
74
75 /**
76 * Gets this {@link EntityPhone}'s unmasked extension number.
77 * @return the unmasked extension number for this {@link EntityPhone}, or null if none has been assigned.
78 */
79 String getExtensionNumberUnmasked();
80
81 /**
82 * Gets this {@link EntityPhone}'s unmasked country code.
83 * @return the unmasked country code for this {@link EntityPhone}, or null if none has been assigned.
84 */
85 String getCountryCodeUnmasked();
86
87 /**
88 * Gets this {@link EntityPhone}'s formatted phone number.
89 * @return the formatted phone number for this {@link EntityPhone}, or null if none has been assigned.
90 */
91 String getFormattedPhoneNumber();
92
93 /**
94 * Gets this {@link EntityPhone}'s unmasked formatted phone number.
95 * @return the unmasked formatted phone number for this {@link EntityPhone}, or null if none has been assigned.
96 */
97 String getFormattedPhoneNumberUnmasked();
98
99 /**
100 * Returns a boolean value that determines if phone fields should be suppressed.
101 * @return boolean value that determines if phone should be suppressed.
102 */
103 boolean isSuppressPhone();
104 }