1 /**
2 * Copyright 2005-2012 The Kuali Foundation
3 *
4 * Licensed under the Educational Community License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.opensource.org/licenses/ecl2.php
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16 package org.kuali.rice.kim.api.identity.principal;
17
18
19 import org.kuali.rice.core.api.mo.common.GloballyUnique;
20 import org.kuali.rice.core.api.mo.common.Versioned;
21 import org.kuali.rice.core.api.mo.common.active.Inactivatable;
22 /**
23 * This is a contract for Principal.
24 *
25 * A principal represents an entity that can authenticate. A principal has an ID that is
26 * used to uniquely identify it. It also has a name that represents the principal's username.
27 * All principals are associated with one and only one entity.
28 *
29 * @author Kuali Rice Team (rice.collab@kuali.org)
30 */
31 public interface PrincipalContract extends Inactivatable, Versioned, GloballyUnique {
32 /**
33 * Gets this {@link PrincipalContract}'s id.
34 * @return the id for this {@link PrincipalContract}, or null if none has been assigned.
35 */
36 String getPrincipalId();
37
38 /**
39 * Gets this {@link PrincipalContract}'s name.
40 * @return the name for this {@link PrincipalContract}, this value cannot be null.
41 */
42 String getPrincipalName();
43
44 /**
45 * Gets this {@link PrincipalContract}'s identity id.
46 * @return the identity id for this {@link PrincipalContract}, or null if none has been assigned.
47 */
48 String getEntityId();
49
50 }