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

Class Principal

java.lang.Object

org.kuali.rice.core.api.mo.AbstractDataTransferObject

org.kuali.rice.kim.api.identity.principal.Principal

All Implemented Interfaces:

Serializable, Inactivatable, GloballyUnique, Versioned, ModelObjectBasic, ModelObjectComplete, PrincipalContract

public final class Principal
extends AbstractDataTransferObject
implements PrincipalContract

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Principal.Builder A builder which can be used to construct Principal instances.
static class	Principal.Cache

Method Summary

Modifier and Type	Method and Description
String	getEntityId() Gets this PrincipalContract's identity id.
String	getObjectId() Return the globally unique object id of this object.
String	getPrincipalId() Gets this PrincipalContract's id.
String	getPrincipalName() Gets this PrincipalContract's name.
Long	getVersionNumber() Returns the version number for this object.
boolean	isActive() The active indicator for an object.

Methods inherited from class org.kuali.rice.core.api.mo.AbstractDataTransferObject

afterUnmarshal, beforeUnmarshal, equals, equalsExcludeFields, getDefaultHashCodeEqualsExcludeFields, hashCode, hashCodeExcludeFields, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getPrincipalId

public String getPrincipalId()

Description copied from interface: PrincipalContract

Gets this PrincipalContract's id.

Specified by:

getPrincipalId in interface PrincipalContract

Returns:

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

getPrincipalName

public String getPrincipalName()

Description copied from interface: PrincipalContract

Gets this PrincipalContract's name.

Specified by:

getPrincipalName in interface PrincipalContract

Returns:

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

getEntityId

public String getEntityId()

Description copied from interface: PrincipalContract

Gets this PrincipalContract's identity id.

Specified by:

getEntityId in interface PrincipalContract

Returns:

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

isActive

public boolean isActive()

Description copied from interface: Inactivatable

The active indicator for an object.

Specified by:

isActive in interface Inactivatable

Returns:

true if active false if not.

getVersionNumber

public Long getVersionNumber()

Description copied from interface: Versioned

Returns the version number for this object. In general, this value should only be null if the object has not yet been stored to a persistent data store. This version number is generally used for the purposes of optimistic locking.

Specified by:

getVersionNumber in interface Versioned

Returns:

the version number, or null if one has not been assigned yet

getObjectId

public String getObjectId()

Description copied from interface: GloballyUnique

Return the globally unique object id of this object. In general, this value should only be null if the object has not yet been stored to a persistent data store.

Specified by:

getObjectId in interface GloballyUnique

Returns:

the objectId of this object, or null if it has not been set yet