001/**
002 * Copyright 2005-2016 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 */
016package org.kuali.rice.kim.api.identity.privacy;
017
018
019import org.kuali.rice.core.api.mo.common.GloballyUnique;
020import org.kuali.rice.core.api.mo.common.Versioned;
021 /**
022  * This is a contract for EntityPrivacyPreferences. Privacy preferences are used to
023  * hide/suppress certain contact information.
024  *
025  * @author Kuali Rice Team (rice.collab@kuali.org)
026  */
027public interface EntityPrivacyPreferencesContract extends Versioned, GloballyUnique {
028
029    /**
030     * Gets this id of the parent identity object.
031     * @return the identity id for this {@link EntityPrivacyPreferencesContract}
032     */
033    String getEntityId();
034
035    /**
036     * This is value designating if Entity Name should be suppressed.
037     *
038     * <p>
039     * This is a boolean value that shows if identity names should be suppressed or not.
040     * </p>
041     *
042     * @return suppressName
043     */
044    boolean isSuppressName();
045
046    /**
047     * This is value designating if Entity Address should be suppressed.
048     *
049     * <p>
050     * This is a boolean value that shows if identity addresses should be suppressed or not.
051     * </p>
052     *
053     * @return suppressAddress
054     */
055        boolean isSuppressAddress();
056
057    /**
058     * This is value designating if Entity Email should be suppressed.
059     *
060     * <p>
061     * This is a boolean value that shows if identity emails should be suppressed or not.
062     * </p>
063     *
064     * @return suppressEmail
065     */
066        boolean isSuppressEmail();
067
068    /**
069     * This is value designating if Entity Phone should be suppressed.
070     *
071     * <p>
072     * This is a boolean value that shows if identity phones should be suppressed or not.
073     * </p>
074     *
075     * @return suppressPhone
076     */
077        boolean isSuppressPhone();
078
079    /**
080     * This is value designating if Entity Personal information should be suppressed.
081     *
082     * <p>
083     * This is a boolean value that shows if identity personal information should be suppressed or not.
084     * </p>
085     *
086     * @return suppressPersonal
087     */
088        boolean isSuppressPersonal();
089}