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.email;
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 contract represents the email information associated with an Entity.
26 *
27 * @author Kuali Rice Team (rice.collab@kuali.org)
28 */
29 public interface EntityEmailContract extends Versioned, GloballyUnique, Defaultable, Inactivatable, Identifiable {
30 /**
31 * Gets this id of the parent identity object.
32 * @return the identity id for this {@link EntityEmailContract}
33 */
34 String getEntityId();
35
36 /**
37 * Gets this entityTypeCode of the {@link EntityEmailContract}'s object.
38 * @return the identity type code for this {@link EntityEmailContract}
39 */
40 String getEntityTypeCode();
41
42 /**
43 * Gets this {@link org.kuali.rice.kim.api.identity.email.EntityEmail}'s type code.
44 * @return the type code for this {@link org.kuali.rice.kim.api.identity.email.EntityEmail}, or null if none has been assigned.
45 */
46 CodedAttributeContract getEmailType();
47
48 /**
49 * Gets this {@link EntityEmail}'s email address.
50 * @return the email address for this {@link EntityEmail}, or null if none has been assigned.
51 */
52 String getEmailAddress();
53
54 /**
55 * Gets this {@link EntityEmail}'s unmasked email address.
56 * @return the unmasked email address for this {@link EntityEmail}, or null if none has been assigned.
57 */
58 String getEmailAddressUnmasked();
59 /**
60 * Returns a boolean value that determines if email fields should be suppressed.
61 * @return boolean value that determines if email should be suppressed.
62 */
63 boolean isSuppressEmail();
64 }