1 /**
2 * Copyright 2005-2012 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.privacy;
17
18
19 import org.kuali.rice.core.api.mo.common.GloballyUnique;
20 import org.kuali.rice.core.api.mo.common.Versioned;
21 /**
22 * This is a contract for EntityPrivacyPreferences. Privacy preferences are used to
23 * hide/suppress certain contact information.
24 *
25 * @author Kuali Rice Team (rice.collab@kuali.org)
26 */
27 public interface EntityPrivacyPreferencesContract extends Versioned, GloballyUnique {
28
29 /**
30 * Gets this id of the parent identity object.
31 * @return the identity id for this {@link EntityPrivacyPreferencesContract}
32 */
33 String getEntityId();
34
35 /**
36 * This is value designating if Entity Name should be suppressed.
37 *
38 * <p>
39 * This is a boolean value that shows if identity names should be suppressed or not.
40 * </p>
41 *
42 * @return suppressName
43 */
44 boolean isSuppressName();
45
46 /**
47 * This is value designating if Entity Address should be suppressed.
48 *
49 * <p>
50 * This is a boolean value that shows if identity addresses should be suppressed or not.
51 * </p>
52 *
53 * @return suppressAddress
54 */
55 boolean isSuppressAddress();
56
57 /**
58 * This is value designating if Entity Email should be suppressed.
59 *
60 * <p>
61 * This is a boolean value that shows if identity emails should be suppressed or not.
62 * </p>
63 *
64 * @return suppressEmail
65 */
66 boolean isSuppressEmail();
67
68 /**
69 * This is value designating if Entity Phone should be suppressed.
70 *
71 * <p>
72 * This is a boolean value that shows if identity phones should be suppressed or not.
73 * </p>
74 *
75 * @return suppressPhone
76 */
77 boolean isSuppressPhone();
78
79 /**
80 * This is value designating if Entity Personal information should be suppressed.
81 *
82 * <p>
83 * This is a boolean value that shows if identity personal information should be suppressed or not.
84 * </p>
85 *
86 * @return suppressPersonal
87 */
88 boolean isSuppressPersonal();
89 }