org.kuali.rice.kim.api.identity.principal
Interface PrincipalContract

All Superinterfaces:

GloballyUnique, Inactivatable, Versioned

All Known Implementing Classes:

LabsUserControl, Principal, Principal.Builder, org.kuali.rice.kim.impl.identity.principal.PrincipalBo

public interface PrincipalContract
extends Inactivatable, Versioned, GloballyUnique

This is a contract for Principal. A principal represents an entity that can authenticate. A principal has an ID that is used to uniquely identify it. It also has a name that represents the principal's username. All principals are associated with one and only one entity.

Author:

Kuali Rice Team (rice.collab@kuali.org)

Method Summary

String	getEntityId() Gets this PrincipalContract's identity id.
String	getPrincipalId() Gets this PrincipalContract's id.
String	getPrincipalName() Gets this PrincipalContract's name.

Methods inherited from interface org.kuali.rice.core.api.mo.common.active.Inactivatable

isActive

Methods inherited from interface org.kuali.rice.core.api.mo.common.Versioned

getVersionNumber

Methods inherited from interface org.kuali.rice.core.api.mo.common.GloballyUnique

getObjectId

Method Detail

getPrincipalId

String getPrincipalId()

Gets this PrincipalContract's id.

Returns:

the id for this PrincipalContract, or null if none has been assigned.

getPrincipalName

String getPrincipalName()

Gets this PrincipalContract's name.

Returns:

the name for this PrincipalContract, this value cannot be null.

getEntityId

String getEntityId()

Gets this PrincipalContract's identity id.

Returns:

the identity id for this PrincipalContract, or null if none has been assigned.