Package org.kuali.rice.kim.api.group

Class GroupMember.Builder

java.lang.Object

org.kuali.rice.kim.api.group.GroupMember.Builder

All Implemented Interfaces:

Serializable, Inactivatable, InactivatableFromTo, GloballyUnique, Identifiable, Versioned, ModelBuilder, GroupMemberContract

Enclosing class:

GroupMember

public static class GroupMember.Builder
extends Object
implements GroupMemberContract, ModelBuilder, Serializable

See Also:

• Serialized Form

Method Summary

Modifier and Type	Method	Description
GroupMember	build()
static GroupMember.Builder	create(String groupId, String memberId, MemberType type)	creates a Parameter with the required fields.
static GroupMember.Builder	create(GroupMemberContract contract)	creates a GroupMember from an existing GroupMemberContract.
org.joda.time.DateTime	getActiveFromDate()
org.joda.time.DateTime	getActiveToDate()
String	getGroupId()	This is the id for the Group.
String	getId()
String	getMemberId()	This is the member id for the Group Member.
String	getObjectId()
MemberType	getType()	This is the type code for the Group Member.
Long	getVersionNumber()
boolean	isActive()
boolean	isActive(org.joda.time.DateTime activeAsOf)
void	setActiveFromDate(org.joda.time.DateTime activeFromDate)
void	setActiveToDate(org.joda.time.DateTime activeToDate)
void	setGroupId(String groupId)
void	setId(String id)
void	setMemberId(String memberId)
void	setObjectId(String objectId)
void	setType(MemberType type)
void	setVersionNumber(Long versionNumber)

Methods inherited from class java.lang.Object

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

Method Details

create

public static GroupMember.Builder create(String groupId,
 String memberId,
 MemberType type)

creates a Parameter with the required fields.

create

public static GroupMember.Builder create(GroupMemberContract contract)

creates a GroupMember from an existing GroupMemberContract.

getId

public String getId()

Specified by:

getId in interface Identifiable

setId

public void setId(String id)

getGroupId

public String getGroupId()

Description copied from interface: GroupMemberContract

This is the id for the Group.

This is a id assigned to a Group. It defines the group this group member belongs to.

Specified by:

getGroupId in interface GroupMemberContract

Returns:

groupId

setGroupId

public void setGroupId(String groupId)

getMemberId

public String getMemberId()

Description copied from interface: GroupMemberContract

This is the member id for the Group Member.

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

Specified by:

getMemberId in interface GroupMemberContract

Returns:

memberId

setMemberId

public void setMemberId(String memberId)

getType

public MemberType getType()

Description copied from interface: GroupMemberContract

This is the type code for the Group Member.

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

Specified by:

getType in interface GroupMemberContract

Returns:

typeCode

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)

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)

isActive

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

Specified by:

isActive in interface InactivatableFromTo

isActive

public boolean isActive()

Specified by:

isActive in interface Inactivatable

build

public GroupMember build()

Specified by:

build in interface ModelBuilder