001    /**
002     * Copyright 2005-2012 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.external;
017    
018    import org.kuali.rice.core.api.mo.common.GloballyUnique;
019    import org.kuali.rice.core.api.mo.common.Identifiable;
020    import org.kuali.rice.core.api.mo.common.Versioned;
021    
022    /**
023     * an external identifier for a KIM identity
024     * 
025     * @author Kuali Rice Team (rice.collab@kuali.org)
026     *
027     */
028    public interface EntityExternalIdentifierContract extends Versioned, GloballyUnique, Identifiable {
029    
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 {@link EntityExternalIdentifierContract}'s type code.
038         * @return the type code for this {@link EntityExternalIdentifierContract}, or null if none has been assigned.
039         */
040            String getExternalIdentifierTypeCode();
041    
042            /**
043         * Gets this {@link EntityExternalIdentifierContract}'s type.
044         * @return the type for this {@link EntityExternalIdentifierContract}, or null if none has been assigned.
045         */
046            EntityExternalIdentifierTypeContract getExternalIdentifierType();
047            
048            /**
049         * Gets this {@link EntityExternalIdentifierContract}'s external id.
050         * @return the external id for this {@link EntityExternalIdentifierContract}, or null if none has been assigned.
051         */
052            String getExternalId();
053    }