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, Inactivatable, InactivatableFromTo, GloballyUnique, Identifiable, Versioned, ModelObjectBasic, ModelObjectComplete, RoleMemberContract

public class RoleMember
extends AbstractDataTransferObject
implements RoleMemberContract

See Also:

Serialized Form

Nested Class Summary

static class	RoleMember.Builder
static class	RoleMember.Cache

Method Summary

org.joda.time.DateTime	getActiveFromDate() Gets the date for which the record become active.
org.joda.time.DateTime	getActiveToDate() Gets the date for which the record become inactive.
Map<String,String>	getAttributes() This returns specific attributes to be set on a Role Member in order to match permission and responsibilitys.
String	getId() The unique identifier for an object.
String	getMemberId() This is the member id for the Role Member.
String	getMemberName()
String	getMemberNamespaceCode()
String	getObjectId() Return the globally unique object id of this object.
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
MemberType	getType() This is the type code for the Role Member.
Long	getVersionNumber() Returns the version number for this object.
boolean	isActive() The active indicator for an object.
boolean	isActive(org.joda.time.DateTime activeAsOfDate) Returns if the record is active for a given Time.

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

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 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()

Description copied from interface: Identifiable

The unique identifier for an object. This can be null.

Specified by:

getId in interface Identifiable

Returns:

the id

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()

Description copied from interface: InactivatableFromTo

Gets the date for which the record become active. Can be null.

Specified by:

getActiveFromDate in interface InactivatableFromTo

Returns:

Timestamp of active from date

getActiveToDate

public org.joda.time.DateTime getActiveToDate()

Description copied from interface: InactivatableFromTo

Gets the date for which the record become inactive. Can be null.

Specified by:

getActiveToDate in interface InactivatableFromTo

Returns:

Timestamp of active to date

isActive

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

Description copied from interface: InactivatableFromTo

Returns if the record is active for a given Time. If the activeAsOfDate is null will return null.

Specified by:

isActive in interface InactivatableFromTo

Returns:

true if active false if not

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.

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

getMemberName

public String getMemberName()

Specified by:

getMemberName in interface RoleMemberContract

getMemberNamespaceCode

public String getMemberNamespaceCode()

Specified by:

getMemberNamespaceCode in interface RoleMemberContract