org.kuali.rice.kim.bo.role.dto
Class KimRoleInfo

java.lang.Object
  org.kuali.rice.kim.bo.role.dto.KimRoleInfo

All Implemented Interfaces:

Serializable, ModelObjectBasic, Role, BusinessObject, ExternalizableBusinessObject

public class KimRoleInfo
extends Object
implements Role, Serializable

Simple Role data designed in DTO form for consumption by web services.

Author:

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

See Also:

Serialized Form

Field Summary

protected boolean	active
protected String	kimTypeId
protected String	namespaceCode
protected String	roleDescription
protected String	roleId
protected String	roleName

Fields inherited from interface org.kuali.rice.kim.bo.Role

GROUP_MEMBER_TYPE, PRINCIPAL_MEMBER_TYPE, ROLE_MEMBER_TYPE

Constructor Summary

KimRoleInfo()

Method Summary

String	getKimTypeId() Type identifier for this role.
String	getNamespaceCode() Namespace for this role - identifies the system/module to which this role applies
String	getRoleDescription() Verbose description of the role and functionally what permissions it implies.
String	getRoleId() Unique identifier for this role.
String	getRoleName() Name for this role.
boolean	isActive()
void	refresh() Refreshes any reference objects from the primitive values.
void	setActive(boolean active)
void	setKimTypeId(String kimTypeId)
void	setNamespaceCode(String namespaceCode)
void	setRoleDescription(String roleDescription)
void	setRoleId(String roleId)
void	setRoleName(String roleName)
String	toString() This will return a proper string representation of the Model Object.

Methods inherited from class java.lang.Object

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

Field Detail

roleId

protected String roleId

roleName

protected String roleName

roleDescription

protected String roleDescription

active

protected boolean active

kimTypeId

protected String kimTypeId

namespaceCode

protected String namespaceCode

Constructor Detail

KimRoleInfo

public KimRoleInfo()

Method Detail

getRoleId

public String getRoleId()

Description copied from interface: Role

Unique identifier for this role.

Specified by:

getRoleId in interface Role

setRoleId

public void setRoleId(String roleId)

getRoleName

public String getRoleName()

Description copied from interface: Role

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

Specified by:

getRoleName in interface Role

setRoleName

public void setRoleName(String roleName)

getRoleDescription

public String getRoleDescription()

Description copied from interface: Role

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

Specified by:

getRoleDescription in interface Role

setRoleDescription

public void setRoleDescription(String roleDescription)

isActive

public boolean isActive()

setActive

public void setActive(boolean active)

getKimTypeId

public String getKimTypeId()

Description copied from interface: Role

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

Specified by:

getKimTypeId in interface Role

setKimTypeId

public void setKimTypeId(String kimTypeId)

getNamespaceCode

public String getNamespaceCode()

Description copied from interface: Role

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

Specified by:

getNamespaceCode in interface Role

setNamespaceCode

public void setNamespaceCode(String namespaceCode)

toString

public String toString()

Description copied from interface: ModelObjectBasic

This will return a proper string representation of the Model Object. All of the fields comprising the "public" api should be represented in the return value.

Specified by:

toString in interface ModelObjectBasic

Overrides:

toString in class Object

Returns:

the string representation

See Also:

Object.toString()

refresh

public void refresh()

Description copied from interface: BusinessObject

Refreshes any reference objects from the primitive values.

Specified by:

refresh in interface BusinessObject