org.kuali.rice.kim.api.role

Interface RoleMemberContract

All Superinterfaces:

GloballyUnique, Identifiable, Inactivatable, InactivatableFromTo, Versioned

All Known Implementing Classes:

RoleMember, RoleMember.Builder, RoleMemberBo

public interface RoleMemberContract
extends Versioned, GloballyUnique, InactivatableFromTo, Identifiable

This is a contract for RoleMember. Role members can be Principals, Groups, or other Roles. Each RoleMember has certain permissions and responsibilities assigned to it based on which role it belongs to.

Author:

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

Method Summary

Methods

Modifier and Type	Method and Description
Map<String,String>	getAttributes() This returns specific attributes to be set on a Role Member in order to match permission and responsibilitys.
String	getMemberId() This is the member id for the Role Member.
String	getMemberName()
String	getMemberNamespaceCode()
String	getRoleId() This is the id for the Role.
List<? extends RoleResponsibilityActionContract>	getRoleRspActions() This returns a list of role responsibility actions assigned to a role member
MemberType	getType() This is the type code for the Role Member.

Methods inherited from interface org.kuali.rice.core.api.mo.common.Versioned

getVersionNumber

Methods inherited from interface org.kuali.rice.core.api.mo.common.GloballyUnique

getObjectId

Methods inherited from interface org.kuali.rice.core.api.mo.common.active.InactivatableFromTo

getActiveFromDate, getActiveToDate, isActive

Methods inherited from interface org.kuali.rice.core.api.mo.common.active.Inactivatable

isActive

Methods inherited from interface org.kuali.rice.core.api.mo.common.Identifiable

getId

Method Detail

getMemberId

String getMemberId()

This is the member id for the Role Member.

This is a id value that defines the Role Member. This value is either a Principal Id, Group Id, or Role Id depending on the type code

Returns:

memberId

getType

MemberType getType()

This is the type code for the Role Member.

This is a value that defines the type of Role Member. This value determines whether memberId is either a Principal Id, Group Id, or Role Id

Returns:

typeCode

getRoleId

String getRoleId()

This is the id for the Role.

This is a id assigned to a Role. It defines the role this role member belongs to.

Returns:

roleId

getAttributes

Map<String,String> getAttributes()

This returns specific attributes to be set on a Role Member in order to match permission and responsibilitys. These attributes match the attributes set to a KimType

Returns:

attributes

getRoleRspActions

List<? extends RoleResponsibilityActionContract> getRoleRspActions()

This returns a list of role responsibility actions assigned to a role member

Returns:

roleRspActions

getMemberName

String getMemberName()

getMemberNamespaceCode

String getMemberNamespaceCode()