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 * email information for a KIM entity
20 *
21 * @author Kuali Rice Team (rice.collab@kuali.org)
22 *
23 */
24 public interface KimEntityEmail extends KimDefaultableEntityTypeData {
25
26 /**
27 * Gets this {@link KimEntityEmail}'s id.
28 * @return the id for this {@link KimEntityEmail}, or null if none has been assigned.
29 */
30 String getEntityEmailId();
31
32 /**
33 * Gets this {@link KimEntityEmail}'s email type code.
34 * @return the email type code for this {@link KimEntityEmail}, or null if none has been assigned.
35 */
36 String getEmailTypeCode();
37
38 /**
39 * Gets this {@link KimEntityEmail}'s entity type code.
40 * @return the entity type code for this {@link KimEntityEmail}, or null if none has been assigned.
41 */
42 String getEntityTypeCode();
43
44 /**
45 * Gets this {@link KimEntityEmail}'s email address.
46 * @return the email address for this {@link KimEntityEmail}, or null if none has been assigned.
47 */
48 String getEmailAddress();
49
50 /**
51 * Gets this {@link KimEntityEmail}'s unmasked email address.
52 * @return the unmasked email address for this {@link KimEntityEmail}, or null if none has been assigned.
53 */
54 String getEmailAddressUnmasked();
55
56 boolean isSuppressEmail();
57 }