001    /**
002     * Copyright 2005-2014 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.principal;
017    
018    
019    import org.kuali.rice.core.api.mo.common.GloballyUnique;
020    import org.kuali.rice.core.api.mo.common.Versioned;
021    import org.kuali.rice.core.api.mo.common.active.Inactivatable;
022    /**
023     * This is a contract for Principal.
024     *
025     * A principal represents an entity that can authenticate. A principal has an ID that is
026     * used to uniquely identify it. It also has a name that represents the principal's username.
027     * All principals are associated with one and only one entity.
028     *
029     * @author Kuali Rice Team (rice.collab@kuali.org)
030     */
031    public interface PrincipalContract extends Inactivatable, Versioned, GloballyUnique {
032       /**
033         * Gets this {@link PrincipalContract}'s id.
034         * @return the id for this {@link PrincipalContract}, or null if none has been assigned.
035         */
036            String getPrincipalId();
037            
038            /**
039         * Gets this {@link PrincipalContract}'s name.
040         * @return the name for this {@link PrincipalContract}, this value cannot be null.
041         */
042            String getPrincipalName();
043            
044            /**
045         * Gets this {@link PrincipalContract}'s identity id.
046         * @return the identity id for this {@link PrincipalContract}, or null if none has been assigned.
047         */
048            String getEntityId();
049            
050    }