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

Interface GroupMemberContract

All Superinterfaces:
org.kuali.rice.core.api.mo.common.GloballyUnique, org.kuali.rice.core.api.mo.common.Identifiable, org.kuali.rice.core.api.mo.common.active.Inactivatable, org.kuali.rice.core.api.mo.common.active.InactivatableFromTo, org.kuali.rice.core.api.mo.common.Versioned
All Known Implementing Classes:
GroupMember, GroupMember.Builder
public interface GroupMemberContract extends org.kuali.rice.core.api.mo.common.Versioned, org.kuali.rice.core.api.mo.common.GloballyUnique, org.kuali.rice.core.api.mo.common.active.InactivatableFromTo, org.kuali.rice.core.api.mo.common.Identifiable
This is a contract for a GroupMember A principal or group is considered to be a "member" of a group if it is either directly assigned to the group or indirectly assigned (via a nested group membership).
Author:
Kuali Rice Team (rice.collab@kuali.org)

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getGroupId()
    This is the id for the Group.
    String
    getMemberId()
    This is the member id for the Group Member.
    org.kuali.rice.core.api.membership.MemberType
    getType()
    This is the type code for the Group Member.

    Methods inherited from interface org.kuali.rice.core.api.mo.common.GloballyUnique

    getObjectId

    Methods inherited from interface org.kuali.rice.core.api.mo.common.Identifiable

    getId

    Methods inherited from interface org.kuali.rice.core.api.mo.common.active.Inactivatable

    isActive

    Methods inherited from interface org.kuali.rice.core.api.mo.common.active.InactivatableFromTo

    getActiveFromDate, getActiveToDate, isActive

    Methods inherited from interface org.kuali.rice.core.api.mo.common.Versioned

    getVersionNumber

  • Method Details

    • getGroupId

      String getGroupId()
      This is the id for the Group.

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

      Returns:
      groupId

    • getMemberId

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

      Returns:
      memberId

    • getType

      org.kuali.rice.core.api.membership.MemberType getType()
      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

      Returns:
      typeCode