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

Class Principal.Builder

java.lang.Object

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

All Implemented Interfaces:

Serializable, Inactivatable, GloballyUnique, Versioned, ModelBuilder, PrincipalContract

Enclosing class:

Principal

public static final class Principal.Builder
extends Object
implements Serializable, ModelBuilder, PrincipalContract

A builder which can be used to construct Principal instances. Enforces the constraints of the PrincipalContract.

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
Principal	build()
static Principal.Builder	create(PrincipalContract contract)
static Principal.Builder	create(String principalName)
String	getEntityId() Gets this PrincipalContract's identity id.
String	getObjectId()
String	getPrincipalId() Gets this PrincipalContract's id.
String	getPrincipalName() Gets this PrincipalContract's name.
Long	getVersionNumber()
boolean	isActive()
void	setActive(boolean active)
void	setEntityId(String entityId)
void	setObjectId(String objectId)
void	setPrincipalId(String principalId)
void	setPrincipalName(String principalName)
void	setVersionNumber(Long versionNumber)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

public static Principal.Builder create(String principalName)

create

public static Principal.Builder create(PrincipalContract contract)

build

public Principal build()

Specified by:

build in interface ModelBuilder

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()

Specified by:

isActive in interface Inactivatable

getVersionNumber

public Long getVersionNumber()

Specified by:

getVersionNumber in interface Versioned

getObjectId

public String getObjectId()

Specified by:

getObjectId in interface GloballyUnique

setPrincipalId

public void setPrincipalId(String principalId)

setPrincipalName

public void setPrincipalName(String principalName)

setEntityId

public void setEntityId(String entityId)

setActive

public void setActive(boolean active)

setVersionNumber

public void setVersionNumber(Long versionNumber)

setObjectId

public void setObjectId(String objectId)