Package org.kuali.rice.kim.api.role

Class Role.Builder

java.lang.Object

org.kuali.rice.kim.api.role.Role.Builder

All Implemented Interfaces:

Serializable, Inactivatable, GloballyUnique, Identifiable, Versioned, ModelBuilder, ModelObjectBasic, ModelObjectComplete, RoleContract

Enclosing class:

Role

public static final class Role.Builder
extends Object
implements RoleContract, ModelBuilder, ModelObjectComplete

See Also:

• Serialized Form

Method Summary

Modifier and Type	Method	Description
Role	build()
static Role.Builder	create()
static Role.Builder	create(String id, String name, String namespaceCode, String description, String kimTypeId)
static Role.Builder	create(RoleContract roleContract)
boolean	equals(Object obj)
String	getDescription()	A full textual description of this role.
String	getId()
String	getKimTypeId()	Provides the associated KimType identifier for this role.
String	getName()	The human readable name for this role.
String	getNamespaceCode()	A namespace for this role.
String	getObjectId()
Long	getVersionNumber()
int	hashCode()
boolean	isActive()
void	setActive(boolean active)
void	setDescription(String description)
void	setId(String id)
void	setKimTypeId(String kimTypeId)
void	setName(String name)
void	setNamespaceCode(String namespaceCode)
void	setObjectId(String objectId)
void	setVersionNumber(Long versionNumber)
String	toString()

Methods inherited from class java.lang.Object

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

Method Details

create

public static Role.Builder create()

create

public static Role.Builder create(String id,
 String name,
 String namespaceCode,
 String description,
 String kimTypeId)

create

public static Role.Builder create(RoleContract roleContract)

build

public Role build()

Specified by:

build in interface ModelBuilder

setId

public void setId(String id)

getId

public String getId()

Specified by:

getId in interface Identifiable

setNamespaceCode

public void setNamespaceCode(String namespaceCode)

getNamespaceCode

public String getNamespaceCode()

Description copied from interface: RoleContract

A namespace for this role. A namespace for a role identifies the system/module to which this role applies.

Specified by:

getNamespaceCode in interface RoleContract

Returns:

Namespace for the role.

setName

public void setName(String name)

getName

public String getName()

Description copied from interface: RoleContract

The human readable name for this role.

Specified by:

getName in interface RoleContract

Returns:

Human readable role name.

setDescription

public void setDescription(String description)

getDescription

public String getDescription()

Description copied from interface: RoleContract

A full textual description of this role. This String should provide a verbose description of the role, what it is meant to provide to principals assigned to it, and what permissions it implies.

Specified by:

getDescription in interface RoleContract

Returns:

Description of the role.

setKimTypeId

public void setKimTypeId(String kimTypeId)

getKimTypeId

public String getKimTypeId()

Description copied from interface: RoleContract

Provides the associated KimType identifier for this role. This controls what additional attributes are available.

Specified by:

getKimTypeId in interface RoleContract

Returns:

KimType Id

setActive

public void setActive(boolean active)

isActive

public boolean isActive()

Specified by:

isActive in interface Inactivatable

setVersionNumber

public void setVersionNumber(Long versionNumber)

getVersionNumber

public Long getVersionNumber()

Specified by:

getVersionNumber in interface Versioned

setObjectId

public void setObjectId(String objectId)

getObjectId

public String getObjectId()

Specified by:

getObjectId in interface GloballyUnique

hashCode

public int hashCode()

Specified by:

hashCode in interface ModelObjectComplete

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Specified by:

equals in interface ModelObjectComplete

Overrides:

equals in class Object

toString

public String toString()

Specified by:

toString in interface ModelObjectBasic

Overrides:

toString in class Object