001    /**
002     * Copyright 2005-2013 The Kuali Foundation
003     *
004     * Licensed under the Educational Community License, Version 2.0 (the "License");
005     * you may not use this file except in compliance with the License.
006     * You may obtain a copy of the License at
007     *
008     * http://www.opensource.org/licenses/ecl2.php
009     *
010     * Unless required by applicable law or agreed to in writing, software
011     * distributed under the License is distributed on an "AS IS" BASIS,
012     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013     * See the License for the specific language governing permissions and
014     * limitations under the License.
015     */
016    package org.kuali.rice.kim.api.identity.email;
017    
018    import org.kuali.rice.core.api.mo.common.Defaultable;
019    import org.kuali.rice.core.api.mo.common.GloballyUnique;
020    import org.kuali.rice.core.api.mo.common.Identifiable;
021    import org.kuali.rice.core.api.mo.common.Versioned;
022    import org.kuali.rice.core.api.mo.common.active.Inactivatable;
023    import org.kuali.rice.kim.api.identity.CodedAttributeContract;
024     /**
025      * This contract represents the email information  associated with an Entity.
026      *
027      * @author Kuali Rice Team (rice.collab@kuali.org)
028      */
029    public interface EntityEmailContract extends Versioned, GloballyUnique, Defaultable, Inactivatable, Identifiable {
030           /**
031         * Gets this id of the parent identity object.
032         * @return the identity id for this {@link EntityEmailContract}
033         */
034        String getEntityId();
035    
036        /**
037         * Gets this entityTypeCode of the {@link EntityEmailContract}'s object.
038         * @return the identity type code for this {@link EntityEmailContract}
039         */
040        String getEntityTypeCode();
041    
042            /**
043         * Gets this {@link org.kuali.rice.kim.api.identity.email.EntityEmail}'s type code.
044         * @return the type code for this {@link org.kuali.rice.kim.api.identity.email.EntityEmail}, or null if none has been assigned.
045         */
046            CodedAttributeContract getEmailType();
047    
048            /**
049         * Gets this {@link EntityEmail}'s email address.
050         * @return the email address for this {@link EntityEmail}, or null if none has been assigned.
051         */
052            String getEmailAddress();
053    
054            /**
055         * Gets this {@link EntityEmail}'s unmasked email address.
056         * @return the unmasked email address for this {@link EntityEmail}, or null if none has been assigned.
057         */
058            String getEmailAddressUnmasked();
059        /**
060         * Returns a boolean value that determines if email fields should be suppressed.
061         * @return boolean value that determines if email should be suppressed.
062         */
063            boolean isSuppressEmail();
064    }