org.kuali.rice.kim.service
Interface GroupService

All Known Implementing Classes:

GroupServiceImpl

public interface GroupService

This service provides operations for checking group membership and querying for group data.

A group is a collection of principals. It's membership consists of direct principal assignment and/or nested group membership. All groups are uniquely identified by a namespace code plus a name.

As mentioned previously, groups support nested group membership. 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). A principal or group is said to be a "direct" member of another group only if it is directly assigned as a member of the group, and not via a nested group assignment.

This service provides read-only operations. For write operations, see GroupUpdateService.

Author:

Kuali Rice Team (rice.collab@kuali.org)

See Also:

GroupUpdateService

Method Summary

List<String>	getDirectGroupIdsForPrincipal(String principalId) Get the groupIds in which the principal has direct membership only.
List<String>	getDirectMemberGroupIds(String groupId) Get all the groups which are direct members of the given group.
List<String>	getDirectMemberPrincipalIds(String groupId) Get all the principals directly assigned to the given group.
List<String>	getDirectParentGroupIds(String groupId) Get the groupIds which that are directly above this group.
Map<String,String>	getGroupAttributes(String groupId) Get all the attributes of the given group.
List<String>	getGroupIdsForPrincipal(String principalId) Get all the groups for the given principal.
List<String>	getGroupIdsForPrincipalByNamespace(String principalId, String namespaceCode) Get all the groups for the given principal in the given namespace.
GroupInfo	getGroupInfo(String groupId) Get the group by the given id.
GroupInfo	getGroupInfoByName(String namespaceCode, String groupName) Get the group by the given namesapce code and name.
Map<String,GroupInfo>	getGroupInfos(Collection<String> groupIds) Gets all groups for the given collection of group ids.
Collection<GroupMembershipInfo>	getGroupMembers(List<String> groupIds) Get the membership info for the members of all the groups with the given group ids.
Collection<GroupMembershipInfo>	getGroupMembersOfGroup(String groupId) Get the membership info for the members of the group with the given id.
List<GroupInfo>	getGroupsForPrincipal(String principalId) Get all the groups for a given principal.
List<GroupInfo>	getGroupsForPrincipalByNamespace(String principalId, String namespaceCode) Get all the groups within a namespace for a given principal.
List<String>	getMemberGroupIds(String groupId) Get all the groups contained by the given group.
List<String>	getMemberPrincipalIds(String groupId) Get all the principals of the given group.
List<String>	getParentGroupIds(String groupId) Get the groups which are parents of the given group.
boolean	isDirectMemberOfGroup(String principalId, String groupId) Check whether the give principal is a member of the group.
boolean	isGroupActive(String groupId) Checks if the group with the given id is active.
boolean	isGroupMemberOfGroup(String groupMemberId, String groupId) Check whether the group identified by groupMemberId is a member of the group identified by groupId.
boolean	isMemberOfGroup(String principalId, String groupId) Check whether the give principal is a member of the group.
List<String>	lookupGroupIds(Map<String,String> searchCriteria) Query for groups based on the given search criteria which is a Map of group field names to values.
List<? extends Group>	lookupGroups(Map<String,String> searchCriteria) Query for groups based on the given search criteria which is a Map of group field names to values.

Method Detail

getGroupsForPrincipal

List<GroupInfo> getGroupsForPrincipal(String principalId)

Get all the groups for a given principal.

This will include all groups directly assigned as well as those inferred by the fact that they are members of higher level groups.

getGroupsForPrincipalByNamespace

List<GroupInfo> getGroupsForPrincipalByNamespace(String principalId,
                                                 String namespaceCode)

Get all the groups within a namespace for a given principal.

This is the same as the getGroupsForPrincipal(String) method except that the results will be filtered by namespace after retrieval.

lookupGroupIds

List<String> lookupGroupIds(Map<String,String> searchCriteria)

Query for groups based on the given search criteria which is a Map of group field names to values.

This method returns it's results as a List of group ids that match the given search criteria.

lookupGroups

List<? extends Group> lookupGroups(Map<String,String> searchCriteria)

Query for groups based on the given search criteria which is a Map of group field names to values.

This method returns it's results as a List of GroupInfo objects that match the given search criteria.

getGroupInfo

GroupInfo getGroupInfo(String groupId)

Get the group by the given id.

getGroupInfoByName

GroupInfo getGroupInfoByName(String namespaceCode,
                             String groupName)

Get the group by the given namesapce code and name.

getGroupInfos

Map<String,GroupInfo> getGroupInfos(Collection<String> groupIds)

Gets all groups for the given collection of group ids.

The result is a Map containing the group id as the key and the group info as the value.

isMemberOfGroup

boolean isMemberOfGroup(String principalId,
                        String groupId)

Check whether the give principal is a member of the group.

This will also return true if the principal is a member of a groups assigned to this group.

isDirectMemberOfGroup

boolean isDirectMemberOfGroup(String principalId,
                              String groupId)

Check whether the give principal is a member of the group.

This will not recurse into contained groups.

getGroupIdsForPrincipal

List<String> getGroupIdsForPrincipal(String principalId)

Get all the groups for the given principal. Recurses into parent groups to provide a comprehensive list.

getGroupIdsForPrincipalByNamespace

List<String> getGroupIdsForPrincipalByNamespace(String principalId,
                                                String namespaceCode)

Get all the groups for the given principal in the given namespace. Recurses into parent groups to provide a comprehensive list.

getDirectGroupIdsForPrincipal

List<String> getDirectGroupIdsForPrincipal(String principalId)

Get the groupIds in which the principal has direct membership only.

isGroupMemberOfGroup

boolean isGroupMemberOfGroup(String groupMemberId,
                             String groupId)

Check whether the group identified by groupMemberId is a member of the group identified by groupId. This will recurse through all groups.

isGroupActive

boolean isGroupActive(String groupId)

Checks if the group with the given id is active. Returns true if it is, false otherwise.

getMemberPrincipalIds

List<String> getMemberPrincipalIds(String groupId)

Get all the principals of the given group. Recurses into contained groups to provide a comprehensive list.

getDirectMemberPrincipalIds

List<String> getDirectMemberPrincipalIds(String groupId)

Get all the principals directly assigned to the given group.

getMemberGroupIds

List<String> getMemberGroupIds(String groupId)

Get all the groups contained by the given group. Recurses into contained groups to provide a comprehensive list.

getDirectMemberGroupIds

List<String> getDirectMemberGroupIds(String groupId)

Get all the groups which are direct members of the given group.

getParentGroupIds

List<String> getParentGroupIds(String groupId)

Get the groups which are parents of the given group.

This will recurse into groups above the given group and build a complete list of all groups included above this group.

getDirectParentGroupIds

List<String> getDirectParentGroupIds(String groupId)

Get the groupIds which that are directly above this group.

getGroupAttributes

Map<String,String> getGroupAttributes(String groupId)

Get all the attributes of the given group.

getGroupMembers

Collection<GroupMembershipInfo> getGroupMembers(List<String> groupIds)

Get the membership info for the members of all the groups with the given group ids.

The collection of GroupMembershipInfo will contain members for all the groups in no defined order. The values returned may or may not be grouped by group id.

getGroupMembersOfGroup

Collection<GroupMembershipInfo> getGroupMembersOfGroup(String groupId)

Get the membership info for the members of the group with the given id.

Only GroupMembershipInfo for direct group members is returned.