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

java.lang.Object
  org.kuali.rice.kim.api.group.GroupMember

All Implemented Interfaces:

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

public class GroupMember
extends Object
implements GroupMemberContract, ModelObjectComplete

See Also:

Serialized Form

Nested Class Summary

static class

GroupMember.Builder

Constructor Summary

GroupMember(GroupMember.Builder builder)

Method Summary

boolean	equals(Object obj) All "Complete" model object's should adhere to the ModelObjectComplete.equals(Object) contract.
Timestamp	getActiveFromDate() Gets the date for which the record become active
Timestamp	getActiveToDate() Gets the date for which the record become inactive
String	getGroupId() This is the id for the Group.
String	getId() This is the uniqe id for the Group Member.
String	getMemberId() This is the member id for the Group Member.
String	getObjectId() Return the globally unique object id of this object.
String	getTypeCode() This is the type code for the Group Member.
Long	getVersionNumber() Returns the version number for this object.
int	hashCode() All "Complete" model object's should adhere to the ModelObjectComplete.hashCode() contract.
String	toString() This will return a proper string representation of the Model Object.

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: GroupMemberContract

This is the uniqe id for the Group Member.

This is a unique id for a Group Member object.

Specified by:

getId in interface GroupMemberContract

Returns:

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

getTypeCode

public String getTypeCode()

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:

getTypeCode in interface GroupMemberContract

Returns:

typeCode

getActiveFromDate

public Timestamp getActiveFromDate()

Description copied from interface: InactivatableFromTo

Gets the date for which the record become active

Specified by:

getActiveFromDate in interface InactivatableFromTo

Returns:

Timestamp of active from date

getActiveToDate

public Timestamp getActiveToDate()

Description copied from interface: InactivatableFromTo

Gets the date for which the record become inactive

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.

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

hashCode

public int hashCode()

Description copied from interface: ModelObjectComplete

All "Complete" model object's should adhere to the ModelObjectComplete.hashCode() contract.

Specified by:

hashCode in interface ModelObjectComplete

Overrides:

hashCode in class Object

Returns:

the hashCode value

equals

public boolean equals(Object obj)

Description copied from interface: ModelObjectComplete

All "Complete" model object's should adhere to the ModelObjectComplete.equals(Object) contract.

Specified by:

equals in interface ModelObjectComplete

Overrides:

equals in class Object

Parameters:

obj - to object to compare for equality

Returns:

if equal

toString

public String toString()

Description copied from interface: ModelObjectBasic

This will return a proper string representation of the Model Object. All of the fields comprising the "public" api should be represented in the return value.

Specified by:

toString in interface ModelObjectBasic

Overrides:

toString in class Object

Returns:

the string representation