/**

  * Copyright 2005-2011 The Kuali Foundation

  *

  * Licensed under the Educational Community License, Version 2.0 (the "License");

  * you may not use this file except in compliance with the License.

  * You may obtain a copy of the License at

  *

  * http://www.opensource.org/licenses/ecl2.php

  *

  * Unless required by applicable law or agreed to in writing, software

  * distributed under the License is distributed on an "AS IS" BASIS,

  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

  * See the License for the specific language governing permissions and

  * limitations under the License.

  */

 package org.kuali.rice.kim.api.identity.email;

 import org.kuali.rice.core.api.mo.common.Defaultable;

 import org.kuali.rice.core.api.mo.common.GloballyUnique;

 import org.kuali.rice.core.api.mo.common.Identifiable;

 import org.kuali.rice.core.api.mo.common.Versioned;

 import org.kuali.rice.core.api.mo.common.active.Inactivatable;

 import org.kuali.rice.kim.api.identity.CodedAttributeContract;

 public interface EntityEmailContract extends Versioned, GloballyUnique, Defaultable, Inactivatable, Identifiable {

        /**

      * Gets this id of the parent identity object.

      * @return the identity id for this {@link EntityEmailContract}

      */

     String getEntityId();

     /**

      * Gets this entityTypeCode of the {@link EntityEmailContract}'s object.

      * @return the identity type code for this {@link EntityEmailContract}

      */

     String getEntityTypeCode();

         /**

      * Gets this {@link org.kuali.rice.kim.api.identity.email.EntityEmail}'s type code.

      * @return the type code for this {@link org.kuali.rice.kim.api.identity.email.EntityEmail}, or null if none has been assigned.

      */

         CodedAttributeContract getEmailType();

         /**

      * Gets this {@link EntityEmail}'s email address.

      * @return the email address for this {@link EntityEmail}, or null if none has been assigned.

      */

         String getEmailAddress();

         /**

      * Gets this {@link EntityEmail}'s unmasked email address.

      * @return the unmasked email address for this {@link EntityEmail}, or null if none has been assigned.

      */

         String getEmailAddressUnmasked();

     /**

      * Returns a boolean value that determines if email fields should be suppressed.

      * @return boolean value that determines if email should be suppressed.

      */

         boolean isSuppressEmail();

 }