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

java.lang.Object
  org.kuali.rice.core.api.mo.AbstractDataTransferObject
      org.kuali.rice.kim.api.group.GroupMember

All Implemented Interfaces:

Serializable, Inactivatable, InactivatableFromTo, GloballyUnique, Identifiable, Versioned, ModelObjectBasic, ModelObjectComplete, GroupMemberContract

public class GroupMember
extends AbstractDataTransferObject
implements GroupMemberContract

See Also:

Serialized Form

Nested Class Summary

static class	GroupMember.Builder
static class	GroupMember.Cache

Constructor Summary

GroupMember(GroupMember.Builder builder)

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.
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.

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

Constructor Detail

GroupMember

public GroupMember(GroupMember.Builder builder)

Method Detail

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

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

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

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

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

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

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.