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

Class RoleMember

java.lang.Object

org.kuali.rice.core.api.mo.AbstractDataTransferObject

org.kuali.rice.kim.api.role.RoleMember

All Implemented Interfaces:

Serializable, org.kuali.rice.core.api.mo.common.active.Inactivatable, org.kuali.rice.core.api.mo.common.active.InactivatableFromTo, org.kuali.rice.core.api.mo.common.GloballyUnique, org.kuali.rice.core.api.mo.common.Identifiable, org.kuali.rice.core.api.mo.common.Versioned, org.kuali.rice.core.api.mo.ModelObjectBasic, org.kuali.rice.core.api.mo.ModelObjectComplete, RoleMemberContract

public class RoleMember
extends org.kuali.rice.core.api.mo.AbstractDataTransferObject
implements RoleMemberContract

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	RoleMember.Builder
static class	RoleMember.Cache

Method Summary

Modifier and Type	Method	Description
org.joda.time.DateTime	getActiveFromDate()
org.joda.time.DateTime	getActiveToDate()
Map<String,String>	getAttributes()	This returns specific attributes to be set on a Role Member in order to match permission and responsibilitys.
String	getId()
String	getMemberId()	This is the member id for the Role Member.
String	getMemberName()
String	getMemberNamespaceCode()
String	getObjectId()
String	getRoleId()	This is the id for the Role.
List<RoleResponsibilityAction>	getRoleRspActions()	This returns a list of role responsibility actions assigned to a role member
org.kuali.rice.core.api.membership.MemberType	getType()	This is the type code for the Role Member.
Long	getVersionNumber()
boolean	isActive()
boolean	isActive(org.joda.time.DateTime activeAsOfDate)

Methods inherited from class org.kuali.rice.core.api.mo.AbstractDataTransferObject

afterUnmarshal, beforeUnmarshal, equals, equalsExcludeFields, getDefaultHashCodeEqualsExcludeFields, hashCode, hashCodeExcludeFields, toString

Methods inherited from class java.lang.Object

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

Method Details

getMemberId

public String getMemberId()

Description copied from interface: RoleMemberContract

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

Specified by:

getMemberId in interface RoleMemberContract

Returns:

memberId

getType

public org.kuali.rice.core.api.membership.MemberType getType()

Description copied from interface: RoleMemberContract

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

Specified by:

getType in interface RoleMemberContract

Returns:

typeCode

getId

public String getId()

Specified by:

getId in interface org.kuali.rice.core.api.mo.common.Identifiable

getRoleId

public String getRoleId()

Description copied from interface: RoleMemberContract

This is the id for the Role.

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

Specified by:

getRoleId in interface RoleMemberContract

Returns:

roleId

getAttributes

public Map<String,String> getAttributes()

Description copied from interface: RoleMemberContract

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

Specified by:

getAttributes in interface RoleMemberContract

Returns:

the attributes

getRoleRspActions

public List<RoleResponsibilityAction> getRoleRspActions()

Description copied from interface: RoleMemberContract

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

Specified by:

getRoleRspActions in interface RoleMemberContract

Returns:

the roleResponsibilityActions

getActiveFromDate

public org.joda.time.DateTime getActiveFromDate()

Specified by:

getActiveFromDate in interface org.kuali.rice.core.api.mo.common.active.InactivatableFromTo

getActiveToDate

public org.joda.time.DateTime getActiveToDate()

Specified by:

getActiveToDate in interface org.kuali.rice.core.api.mo.common.active.InactivatableFromTo

isActive

public boolean isActive(org.joda.time.DateTime activeAsOfDate)

Specified by:

isActive in interface org.kuali.rice.core.api.mo.common.active.InactivatableFromTo

isActive

public boolean isActive()

Specified by:

isActive in interface org.kuali.rice.core.api.mo.common.active.Inactivatable

getVersionNumber

public Long getVersionNumber()

Specified by:

getVersionNumber in interface org.kuali.rice.core.api.mo.common.Versioned

getObjectId

public String getObjectId()

Specified by:

getObjectId in interface org.kuali.rice.core.api.mo.common.GloballyUnique

getMemberName

public String getMemberName()

Specified by:

getMemberName in interface RoleMemberContract

getMemberNamespaceCode

public String getMemberNamespaceCode()

Specified by:

getMemberNamespaceCode in interface RoleMemberContract