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

Class RoleMember.Builder

java.lang.Object

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

All Implemented Interfaces:

Serializable, Inactivatable, InactivatableFromTo, GloballyUnique, Identifiable, Versioned, ModelBuilder, ModelObjectBasic, ModelObjectComplete, RoleMemberContract

Enclosing class:

RoleMember

public static final class RoleMember.Builder
extends Object
implements ModelBuilder, RoleMemberContract, ModelObjectComplete

See Also:

• Serialized Form

Method Summary

Modifier and Type	Method	Description
RoleMember	build()
static RoleMember.Builder	create(String roleId, String id, String memberId, MemberType memberType, org.joda.time.DateTime activeFromDate, org.joda.time.DateTime activeToDate, Map<String,String> attributes, String memberName, String memberNamespaceCode)
static RoleMember.Builder	create(RoleMemberContract contract)
boolean	equals(Object obj)
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.Builder>	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()
int	hashCode()
boolean	isActive()
boolean	isActive(org.joda.time.DateTime activeAsOfDate)
void	setActiveFromDate(org.joda.time.DateTime activeFromDate)
void	setActiveToDate(org.joda.time.DateTime activeToDate)
void	setAttributes(Map<String,String> attributes)
void	setId(String id)
void	setMemberId(String memberId)
void	setMemberName(String memberName)
void	setMemberNamespaceCode(String memberNamespaceCode)
void	setObjectId(String objectId)
void	setRoleId(String roleId)
void	setRoleRspActions(List<RoleResponsibilityAction.Builder> roleRspActions)
void	setType(MemberType type)
void	setVersionNumber(Long versionNumber)
String	toString()

Methods inherited from class java.lang.Object

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

Method Details

create

public static RoleMember.Builder create(String roleId,
 String id,
 String memberId,
 MemberType memberType,
 org.joda.time.DateTime activeFromDate,
 org.joda.time.DateTime activeToDate,
 Map<String,String> attributes,
 String memberName,
 String memberNamespaceCode)

create

public static RoleMember.Builder create(RoleMemberContract contract)

build

public RoleMember build()

Specified by:

build in interface ModelBuilder

getId

public String getId()

Specified by:

getId in interface Identifiable

setId

public void setId(String 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

setRoleId

public void setRoleId(String 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:

attributes

setAttributes

public void setAttributes(Map<String,String> attributes)

getRoleRspActions

public List<RoleResponsibilityAction.Builder> 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:

roleRspActions

setRoleRspActions

public void setRoleRspActions(List<RoleResponsibilityAction.Builder> roleRspActions)

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

setMemberId

public void setMemberId(String 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

getMemberName

public String getMemberName()

Specified by:

getMemberName in interface RoleMemberContract

setMemberName

public void setMemberName(String memberName)

getMemberNamespaceCode

public String getMemberNamespaceCode()

Specified by:

getMemberNamespaceCode in interface RoleMemberContract

setMemberNamespaceCode

public void setMemberNamespaceCode(String memberNamespaceCode)

setType

public void setType(MemberType type)

getActiveFromDate

public org.joda.time.DateTime getActiveFromDate()

Specified by:

getActiveFromDate in interface InactivatableFromTo

setActiveFromDate

public void setActiveFromDate(org.joda.time.DateTime activeFromDate)

getActiveToDate

public org.joda.time.DateTime getActiveToDate()

Specified by:

getActiveToDate in interface InactivatableFromTo

setActiveToDate

public void setActiveToDate(org.joda.time.DateTime activeToDate)

isActive

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

Specified by:

isActive in interface InactivatableFromTo

isActive

public boolean isActive()

Specified by:

isActive in interface Inactivatable

getVersionNumber

public Long getVersionNumber()

Specified by:

getVersionNumber in interface Versioned

setVersionNumber

public void setVersionNumber(Long versionNumber)

getObjectId

public String getObjectId()

Specified by:

getObjectId in interface GloballyUnique

setObjectId

public void setObjectId(String objectId)

hashCode

public int hashCode()

Specified by:

hashCode in interface ModelObjectComplete

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Specified by:

equals in interface ModelObjectComplete

Overrides:

equals in class Object

toString

public String toString()

Specified by:

toString in interface ModelObjectBasic

Overrides:

toString in class Object