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

Methods

Modifier and Type	Method and Description
GroupMember	build() Returns an instance of the object being built by this builder based on the current state of the builder.
static GroupMember.Builder	create(GroupMemberContract contract) creates a GroupMember from an existing GroupMemberContract.
static GroupMember.Builder	create(String groupId, String memberId, MemberType type) creates a Parameter with the required fields.
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.
String	getGroupId() This is the id for the Group.
String	getId() The unique identifier for an object.
String	getMemberId() This is the member id for the Group Member.
String	getObjectId() Return the globally unique object id of this object.
MemberType	getType() This is the type code for the Group Member.
Long	getVersionNumber() Returns the version number for this object.
boolean	isActive() The active indicator for an object.
boolean	isActive(org.joda.time.DateTime activeAsOf) Returns if the record is active for a given Time.
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 Detail

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

Description copied from interface: Identifiable

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

Specified by:

getId in interface Identifiable

Returns:

the id

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

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

setActiveFromDate

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

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

setActiveToDate

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

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

setVersionNumber

public void setVersionNumber(Long versionNumber)

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

setObjectId

public void setObjectId(String objectId)

isActive

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

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.

build

public GroupMember build()

Description copied from interface: ModelBuilder

Returns an instance of the object being built by this builder based on the current state of the builder. It should be possible to invoke this method more than once on the same builder. It should never return null;

Specified by:

build in interface ModelBuilder

Returns:

an instance of the object being built by this builder, should never return null