001/**
002 * Copyright 2005-2017 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.phone;
017
018import org.kuali.rice.core.api.mo.common.Defaultable;
019import org.kuali.rice.core.api.mo.common.GloballyUnique;
020import org.kuali.rice.core.api.mo.common.Identifiable;
021import org.kuali.rice.core.api.mo.common.Versioned;
022import org.kuali.rice.core.api.mo.common.active.Inactivatable;
023import org.kuali.rice.kim.api.identity.CodedAttributeContract;
024/**
025 * This is a contract for EntityPhone and represents the
026 * phone information of an Entity.
027 *
028 * @author Kuali Rice Team (rice.collab@kuali.org)
029 */
030
031public interface EntityPhoneContract extends Versioned, GloballyUnique, Defaultable, Inactivatable, Identifiable {
032
033    /**
034     * Gets this id of the parent identity object.
035     * @return the identity id for this {@link EntityPhoneContract}
036     */
037    String getEntityId();
038
039    /**
040     * Gets this entityTypeCode of the {@link EntityPhoneContract}'s object.
041     * @return the identity type code for this {@link EntityPhoneContract}
042     */
043    String getEntityTypeCode();
044
045        /**
046     * Gets this {@link EntityPhone}'s type code.
047     * @return the type code for this {@link EntityPhone}, or null if none has been assigned.
048     */
049        CodedAttributeContract getPhoneType();
050
051        /**
052     * Gets this {@link EntityPhone}'s phone number.
053     * @return the phone number for this {@link EntityPhone}, or null if none has been assigned.
054     */
055        String getPhoneNumber();
056
057        /**
058     * Gets this {@link EntityPhone}'s extension number.
059     * @return the extension number for this {@link EntityPhone}, or null if none has been assigned.
060     */
061        String getExtensionNumber();
062
063        /**
064     * Gets this {@link EntityPhone}'s country code.
065     * @return the country code for this {@link EntityPhone}, or null if none has been assigned.
066     */
067        String getCountryCode();
068
069        /**
070     * Gets this {@link EntityPhone}'s unmasked phone number.
071     * @return the unmasked phone number for this {@link EntityPhone}, or null if none has been assigned.
072     */
073        String getPhoneNumberUnmasked();
074
075        /**
076     * Gets this {@link EntityPhone}'s unmasked extension number.
077     * @return the unmasked extension number for this {@link EntityPhone}, or null if none has been assigned.
078     */
079    String getExtensionNumberUnmasked();
080
081    /**
082     * Gets this {@link EntityPhone}'s unmasked country code.
083     * @return the unmasked country code for this {@link EntityPhone}, or null if none has been assigned.
084     */
085    String getCountryCodeUnmasked();
086
087    /**
088     * Gets this {@link EntityPhone}'s formatted phone number.
089     * @return the formatted phone number for this {@link EntityPhone}, or null if none has been assigned.
090     */
091    String getFormattedPhoneNumber();
092
093    /**
094     * Gets this {@link EntityPhone}'s unmasked formatted phone number.
095     * @return the unmasked formatted phone number for this {@link EntityPhone}, or null if none has been assigned.
096     */
097        String getFormattedPhoneNumberUnmasked();
098
099    /**
100     * Returns a boolean value that determines if phone fields should be suppressed.
101     * @return boolean value that determines if phone should be suppressed.
102     */
103        boolean isSuppressPhone();
104}