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

java.lang.Object
  org.kuali.rice.core.api.mo.AbstractDataTransferObject
      org.kuali.rice.kim.api.role.Role

All Implemented Interfaces:

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

public final class Role
extends AbstractDataTransferObject
implements RoleContract

This is a description of what this class does - shyu don't forget to fill this in.

Author:

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

See Also:

Serialized Form

Nested Class Summary

static class	Role.Builder
static class	Role.Cache

Method Summary

String	getDescription() Verbose description of the role and functionally what permissions it implies.
String	getId() Unique identifier for this role.
String	getKimTypeId() Type identifier for this role.
String	getName() Name for this role.
String	getNamespaceCode() Namespace for this role - identifies the system/module to which this role applies
String	getObjectId() Return the globally unique object id of this object.
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, hashCode, toString

Methods inherited from class java.lang.Object

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

Method Detail

getId

public String getId()

Unique identifier for this role.

Specified by:

getId in interface Identifiable

Returns:

the id

getNamespaceCode

public String getNamespaceCode()

Namespace for this role - identifies the system/module to which this role applies

Specified by:

getNamespaceCode in interface RoleContract

Returns:

Namespace for the role.

getName

public String getName()

Name for this role. This value will be seen by the users.

Specified by:

getName in interface RoleContract

Returns:

Human readable role name.

getDescription

public String getDescription()

Verbose description of the role and functionally what permissions it implies.

Specified by:

getDescription in interface RoleContract

Returns:

Description of the role.

getKimTypeId

public String getKimTypeId()

Type identifier for this role. This will control what additional attributes are available

Specified by:

getKimTypeId in interface RoleContract

Returns:

KimType Id

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

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.