org.kuali.rice.kim.impl.group
Class GroupServiceImpl

java.lang.Object
  org.kuali.rice.kim.impl.group.GroupServiceBase
      org.kuali.rice.kim.impl.group.GroupServiceImpl

All Implemented Interfaces:

GroupService

public class GroupServiceImpl
extends GroupServiceBase
implements GroupService

Constructor Summary

GroupServiceImpl()

Method Summary

boolean	addGroupToGroup(String childId, String parentId) Adds the group with the id supplied in childId as a member of the group with the id supplied in parentId.
boolean	addPrincipalToGroup(String principalId, String groupId) Add the principal with the given principalId as a member of the group with the given groupId.
Group	createGroup(Group group) Creates a new group using the given Group.
GroupMember	createGroupMember(GroupMember groupMember) Creates a new group using the given GroupMember.
List<String>	findGroupIds(QueryByCriteria queryByCriteria) Query for groups based on the given search criteria which is a Map of group field names to values.
GroupMemberQueryResults	findGroupMembers(QueryByCriteria queryByCriteria) Query for group members based on the given search criteria which is a Map of group member field names to values.
GroupQueryResults	findGroups(QueryByCriteria queryByCriteria) Query for groups based on the given search criteria which is a Map of group field names to values.
Map<String,String>	getAttributes(String groupId) Get all the attributes of the given group.
List<String>	getDirectGroupIdsByPrincipalId(String principalId) Get all the groups for the given principal.
protected Collection<Group>	getDirectGroupsForPrincipal(String principalId)
protected Collection<Group>	getDirectGroupsForPrincipal(String principalId, String namespaceCode, org.joda.time.DateTime asOfDate)
List<String>	getDirectMemberGroupIds(String groupId) Returns all group ids that are direct members of the given group id.
List<String>	getDirectMemberGroupIdsWithDate(String groupId)
List<String>	getDirectMemberPrincipalIds(String groupId) Returns all principal ids that are direct members of the given group id.
List<String>	getDirectParentGroupIds(String groupId) Returns all parent groups ids that the given group id is a member of.
List<String>	getDirectParentGroupIdsWithDate(String groupId, org.joda.time.DateTime asOfDate)
protected List<Group>	getDirectParentGroups(String groupId, org.joda.time.DateTime asOfDate)
Group	getGroup(String groupId) Lookup a Group based on the passed in id.
protected GroupBo	getGroupBo(String groupId)
Group	getGroupByNamespaceCodeAndName(String namespaceCode, String groupName) Lookup a Group based on the passed in namespace and name.
List<String>	getGroupIdsByPrincipalId(String principalId) Get all the groups for the given principal.
List<String>	getGroupIdsByPrincipalIdAndNamespaceCode(String principalId, String namespaceCode) Get all the groups for the given principal.
protected List<String>	getGroupIdsByPrincipalIdAndNamespaceCodeInternal(String principalId, String namespaceCode)
protected GroupMemberBo	getGroupMemberBo(String id)
List<Group>	getGroups(Collection<String> groupIds) Gets all groups for the given collection of group ids.
List<Group>	getGroupsByPrincipalId(String principalId) Get all the groups for a given principal.
List<Group>	getGroupsByPrincipalIdAndNamespaceCode(String principalId, String namespaceCode) Get all the groups within a namespace for a given principal.
protected List<Group>	getGroupsByPrincipalIdAndNamespaceCodeInternal(String principalId, String namespaceCode)
protected List<GroupBo>	getMemberGroupBos(String groupId)
List<String>	getMemberGroupIds(String groupId) Returns all group ids that are members of the given group id.
protected void	getMemberGroupsInternal(GroupBo group, Set<GroupBo> groups)
protected List<String>	getMemberIdsByType(Collection<GroupMember> members, MemberType memberType)
List<String>	getMemberPrincipalIds(String groupId) Returns all principal ids that are members of the given group id.
protected List<String>	getMemberPrincipalIdsInternal(String groupId, Set<String> visitedGroupIds)
List<GroupMember>	getMembers(List<String> groupIds) Get all GroupMembers all the groups with the given group ids.
List<GroupMember>	getMembersOfGroup(String groupId) Get all GroupMembers all the groups with a given group id.
List<GroupMember>	getMembersOfGroupWithDate(String groupId, org.joda.time.DateTime asOfDate) Get all GroupMembers all the groups with a given group id and asOfDate.
List<GroupMember>	getMembersWithDate(List<String> groupIds, org.joda.time.DateTime asOfDate)
List<String>	getParentGroupIds(String groupId) Returns all parent groups ids that the given group id is a member of.
protected List<Group>	getParentGroups(String groupId)
protected void	getParentGroupsInternal(String groupId, Set<Group> groups)
boolean	isDirectMemberOfGroup(String principalId, String groupId) Check whether the give principal is a member of the group.
boolean	isGroupMemberOfGroup(String groupMemberId, String groupId) Check whether the group identified by groupMemberId is a member of the group identified by groupId.
boolean	isGroupMemberOfGroupWithDate(String groupMemberId, String groupId, org.joda.time.DateTime asOfDate)
boolean	isMemberOfGroup(String principalId, String groupId) Check whether the give principal is a member of the group.
protected boolean	isMemberOfGroupInternal(String memberId, String groupId, Set<String> visitedGroupIds, MemberType memberType, org.joda.time.DateTime asOfDate)
boolean	isMemberOfGroupWithDate(String principalId, String groupId, org.joda.time.DateTime asOfDate)
void	removeAllMembers(String groupId) Removes all members from the group with the given groupId.
boolean	removeGroupFromGroup(String childId, String parentId) Removes the group with the id supplied in childId from the group with the id supplied in parentId.
boolean	removePrincipalFromGroup(String principalId, String groupId) Removes the member principal with the given principalId from the group with the given groupId.
protected GroupBo	saveGroup(GroupBo group)
void	setDataObjectService(DataObjectService dataObjectService)
Group	updateGroup(Group group) Updates an existing group using the given Group.
Group	updateGroup(String groupId, Group group) Updates a group using the given Group.
GroupMember	updateGroupMember(GroupMember groupMember) Updates an existing group using the given GroupMember.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GroupServiceImpl

public GroupServiceImpl()

Method Detail

getGroup

public Group getGroup(String groupId)
               throws RiceIllegalArgumentException

Description copied from interface: GroupService

Lookup a Group based on the passed in id.

Specified by:

getGroup in interface GroupService

Parameters:

groupId - String that matches the desired Groups id

Returns:

a Group with the given id value. A null reference is returned if an invalid or non-existant id is supplied.

Throws:

RiceIllegalArgumentException - if the groupId is null or blank

getGroupsByPrincipalId

public List<Group> getGroupsByPrincipalId(String principalId)
                                   throws RiceIllegalArgumentException

Description copied from interface: GroupService

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.

Specified by:

getGroupsByPrincipalId in interface GroupService

Parameters:

principalId - The id of the Principal

Returns:

a list of Group objects in which the given Principal is a member of. An empty list is returned if an invalid or non-existant principalId is supplied.

Throws:

RiceIllegalArgumentException - if the principalId is null or blank

getGroupsByPrincipalIdAndNamespaceCode

public List<Group> getGroupsByPrincipalIdAndNamespaceCode(String principalId,
                                                          String namespaceCode)
                                                   throws RiceIllegalArgumentException

Description copied from interface: GroupService

Get all the groups within a namespace 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, and filtered by Group namespace.

Specified by:

getGroupsByPrincipalIdAndNamespaceCode in interface GroupService

Parameters:

principalId - The id of the Principal

namespaceCode - The namespace code of the desired Groups to return

Returns:

a list of Group objects in which the given Principal is a member of, filtered by Group namespace. An empty list is returned if an invalid or non-existant principalId is supplied.

Throws:

RiceIllegalArgumentException - if the principalId, namespaceCode is null or blank

getGroupsByPrincipalIdAndNamespaceCodeInternal

protected List<Group> getGroupsByPrincipalIdAndNamespaceCodeInternal(String principalId,
                                                                     String namespaceCode)
                                                              throws RiceIllegalArgumentException

Throws:

RiceIllegalArgumentException

findGroupIds

public List<String> findGroupIds(QueryByCriteria queryByCriteria)
                          throws RiceIllegalArgumentException

Description copied from interface: GroupService

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.

Specified by:

findGroupIds in interface GroupService

Parameters:

queryByCriteria - the criteria. Cannot be null.

Returns:

a list of groupId Strings in which the given criteria match Group properties. An empty list is returned if an invalid or non-existent criteria is supplied.

Throws:

RiceIllegalArgumentException - if the queryByCriteria is null

isDirectMemberOfGroup

public boolean isDirectMemberOfGroup(String principalId,
                                     String groupId)
                              throws RiceIllegalArgumentException

Description copied from interface: GroupService

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

This method does not recurse into contained groups.

Specified by:

isDirectMemberOfGroup in interface GroupService

Parameters:

principalId - Id of the principal

groupId - Id string of group

Returns:

true if principal is a direct member of the group.

Throws:

RiceIllegalArgumentException - if the principalId, groupId is null or blank

getGroupIdsByPrincipalId

public List<String> getGroupIdsByPrincipalId(String principalId)
                                      throws RiceIllegalArgumentException

Description copied from interface: GroupService

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

This returns id for all groups for a given principal id.

Specified by:

getGroupIdsByPrincipalId in interface GroupService

Parameters:

principalId - Id of a Principal

Returns:

a list of Group Ids in which the principal is a member of.

Throws:

RiceIllegalArgumentException - if the principalId is null or blank

getGroupIdsByPrincipalIdAndNamespaceCode

public List<String> getGroupIdsByPrincipalIdAndNamespaceCode(String principalId,
                                                             String namespaceCode)
                                                      throws RiceIllegalArgumentException

Description copied from interface: GroupService

Get all the groups for the given principal. Recurses into parent groups to provide a comprehensive list. This is limited to the passed in Group's namespace.

This returns id for all groups for a given principal id, limited to specific Group namespace.

Specified by:

getGroupIdsByPrincipalIdAndNamespaceCode in interface GroupService

Parameters:

principalId - Id of a Principal

namespaceCode - Namspace code to limit group results to

Returns:

a list of Group Ids in which the principal is a member of, limited to the passed in namespace.

Throws:

RiceIllegalArgumentException - if the principalId, namespaceCode is null or blank

getGroupIdsByPrincipalIdAndNamespaceCodeInternal

protected List<String> getGroupIdsByPrincipalIdAndNamespaceCodeInternal(String principalId,
                                                                        String namespaceCode)
                                                                 throws RiceIllegalArgumentException

Throws:

RiceIllegalArgumentException

getDirectGroupIdsByPrincipalId

public List<String> getDirectGroupIdsByPrincipalId(String principalId)
                                            throws RiceIllegalArgumentException

Description copied from interface: GroupService

Get all the groups for the given principal. Does not recurse into parent groups.

This returns id for all groups for a given principal id.

Specified by:

getDirectGroupIdsByPrincipalId in interface GroupService

Parameters:

principalId - Id of a Principal

Returns:

a list of Group Ids in which the principal is directly a member of.

Throws:

RiceIllegalArgumentException - if the principalId is null or blank

getMemberPrincipalIds

public List<String> getMemberPrincipalIds(String groupId)
                                   throws RiceIllegalArgumentException

Description copied from interface: GroupService

Returns all principal ids that are members of the given group id. Recurses into contained groups for comprehensive list.

Will return a list of all principal ids for members this group.

Specified by:

getMemberPrincipalIds in interface GroupService

Parameters:

groupId - Id string of group

Returns:

List of principal ids

Throws:

RiceIllegalArgumentException - if the groupId is null or blank

getDirectMemberPrincipalIds

public List<String> getDirectMemberPrincipalIds(String groupId)
                                         throws RiceIllegalArgumentException

Description copied from interface: GroupService

Returns all principal ids that are direct members of the given group id.

Will return a list of all principal ids for direct members this group.

Specified by:

getDirectMemberPrincipalIds in interface GroupService

Parameters:

groupId - Id string of group

Returns:

List of direct member principal ids.

Throws:

RiceIllegalArgumentException - if the groupId is null or blank

getMemberGroupIds

public List<String> getMemberGroupIds(String groupId)
                               throws RiceIllegalArgumentException

Description copied from interface: GroupService

Returns all group ids that are members of the given group id. Recurses into contained groups for a comprehensive list.

Will return a list of all group ids for members this group.

Specified by:

getMemberGroupIds in interface GroupService

Parameters:

groupId - Id string of group

Returns:

List of group ids

Throws:

RiceIllegalArgumentException - if the groupId is null or blank

getMemberGroupBos

protected List<GroupBo> getMemberGroupBos(String groupId)

getMemberGroupsInternal

protected void getMemberGroupsInternal(GroupBo group,
                                       Set<GroupBo> groups)

isGroupMemberOfGroup

public boolean isGroupMemberOfGroup(String groupMemberId,
                                    String groupId)
                             throws RiceIllegalArgumentException

Description copied from interface: GroupService

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

Will return true if the group is a member of the group or a group assigned to this group.

Specified by:

isGroupMemberOfGroup in interface GroupService

Parameters:

groupMemberId - Id of the principal

groupId - Id string of group

Returns:

true if group is a member of the group or a member of a group assigned to the the group.

Throws:

RiceIllegalArgumentException - if the groupMemberId, groupId is null or blank

isGroupMemberOfGroupWithDate

public boolean isGroupMemberOfGroupWithDate(String groupMemberId,
                                            String groupId,
                                            org.joda.time.DateTime asOfDate)
                                     throws RiceIllegalArgumentException

Specified by:

isGroupMemberOfGroupWithDate in interface GroupService

Throws:

RiceIllegalArgumentException

isMemberOfGroup

public boolean isMemberOfGroup(String principalId,
                               String groupId)
                        throws RiceIllegalArgumentException

Description copied from interface: GroupService

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

Will return true if the principal is a member of the group or a group assigned to this group.

Specified by:

isMemberOfGroup in interface GroupService

Parameters:

principalId - Id of the principal

groupId - Id string of group

Returns:

true if principal is a member of the group or a member of a group assigned to the the group.

Throws:

RiceIllegalArgumentException - if the principalId, groupId is null or blank

isMemberOfGroupWithDate

public boolean isMemberOfGroupWithDate(String principalId,
                                       String groupId,
                                       org.joda.time.DateTime asOfDate)
                                throws RiceIllegalArgumentException

Specified by:

isMemberOfGroupWithDate in interface GroupService

Throws:

RiceIllegalArgumentException

getDirectMemberGroupIds

public List<String> getDirectMemberGroupIds(String groupId)
                                     throws RiceIllegalArgumentException

Description copied from interface: GroupService

Returns all group ids that are direct members of the given group id.

Will return a list of all group ids for direct members this group.

Specified by:

getDirectMemberGroupIds in interface GroupService

Parameters:

groupId - Id string of group

Returns:

List of direct member group ids.

Throws:

RiceIllegalArgumentException - if the groupId is null or blank

getDirectMemberGroupIdsWithDate

public List<String> getDirectMemberGroupIdsWithDate(String groupId)
                                             throws RiceIllegalArgumentException

Specified by:

getDirectMemberGroupIdsWithDate in interface GroupService

Throws:

RiceIllegalArgumentException

getParentGroupIds

public List<String> getParentGroupIds(String groupId)
                               throws RiceIllegalArgumentException

Description copied from interface: GroupService

Returns all parent groups ids that the given group id is a member of. Recurses parent groups for a comprehensive list.

Will return a list of all group ids that the given group id is a member of.

Specified by:

getParentGroupIds in interface GroupService

Parameters:

groupId - Id string of group

Returns:

List of parent group ids.

Throws:

RiceIllegalArgumentException - if the groupId is null or blank

getDirectParentGroupIds

public List<String> getDirectParentGroupIds(String groupId)
                                     throws RiceIllegalArgumentException

Description copied from interface: GroupService

Returns all parent groups ids that the given group id is a member of.

Will return a list of all group ids that the given group id is a member of.

Specified by:

getDirectParentGroupIds in interface GroupService

Parameters:

groupId - Id string of group

Returns:

List of parent group ids.

Throws:

RiceIllegalArgumentException - if the groupId is null or blank

getDirectParentGroupIdsWithDate

public List<String> getDirectParentGroupIdsWithDate(String groupId,
                                                    org.joda.time.DateTime asOfDate)
                                             throws RiceIllegalArgumentException

Specified by:

getDirectParentGroupIdsWithDate in interface GroupService

Throws:

RiceIllegalArgumentException

getAttributes

public Map<String,String> getAttributes(String groupId)
                                 throws RiceIllegalArgumentException

Description copied from interface: GroupService

Get all the attributes of the given group.

Specified by:

getAttributes in interface GroupService

Throws:

RiceIllegalArgumentException - if the groupId is null or blank

getMembers

public List<GroupMember> getMembers(List<String> groupIds)
                             throws RiceIllegalArgumentException

Description copied from interface: GroupService

Get all GroupMembers all the groups with the given group ids.

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

Specified by:

getMembers in interface GroupService

Parameters:

groupIds - Ids of groups

Returns:

Collection of GroupMembers.

Throws:

RiceIllegalArgumentException - if the groupIds is null or empty

getMembersWithDate

public List<GroupMember> getMembersWithDate(List<String> groupIds,
                                            org.joda.time.DateTime asOfDate)
                                     throws RiceIllegalArgumentException

Specified by:

getMembersWithDate in interface GroupService

Throws:

RiceIllegalArgumentException

getGroups

public List<Group> getGroups(Collection<String> groupIds)
                      throws RiceIllegalArgumentException

Description copied from interface: GroupService

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 as the value.

Specified by:

getGroups in interface GroupService

Parameters:

groupIds - Collection that matches the desired Groups' id

Returns:

a Map of Groups with the given id values. An empty Map is returned if an invalid or non-existant id is supplied.

Throws:

RiceIllegalArgumentException - if the groupIds null or empty

getGroupByNamespaceCodeAndName

public Group getGroupByNamespaceCodeAndName(String namespaceCode,
                                            String groupName)
                                     throws RiceIllegalArgumentException

Description copied from interface: GroupService

Lookup a Group based on the passed in namespace and name.

Specified by:

getGroupByNamespaceCodeAndName in interface GroupService

Parameters:

namespaceCode - String that matches the desired Group's namespaceCode

groupName - String that matches the desired Group's name

Returns:

a Group with the given namespace and name values. A null reference is returned if an invalid or non-existant id is supplied.

Throws:

RiceIllegalArgumentException - if the namespaceCode, groupName is null or blank

findGroups

public GroupQueryResults findGroups(QueryByCriteria queryByCriteria)
                             throws RiceIllegalArgumentException

Description copied from interface: GroupService

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 Groups that match the given search criteria.

Specified by:

findGroups in interface GroupService

Parameters:

queryByCriteria - the criteria. Cannot be null.

Returns:

a list of Group objects in which the given criteria match Group properties. An empty list is returned if an invalid or non-existent criteria is supplied.

Throws:

RiceIllegalArgumentException - if the queryByCriteria is null

findGroupMembers

public GroupMemberQueryResults findGroupMembers(QueryByCriteria queryByCriteria)
                                         throws RiceIllegalArgumentException

Description copied from interface: GroupService

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

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

Specified by:

findGroupMembers in interface GroupService

Parameters:

queryByCriteria - the criteria. Cannot be null.

Returns:

a list of GroupMember objects in which the given criteria match Group properties. An empty list is returned if an invalid or non-existent criteria is supplied.

Throws:

RiceIllegalArgumentException - if the queryByCriteria is null

isMemberOfGroupInternal

protected boolean isMemberOfGroupInternal(String memberId,
                                          String groupId,
                                          Set<String> visitedGroupIds,
                                          MemberType memberType,
                                          org.joda.time.DateTime asOfDate)

getParentGroupsInternal

protected void getParentGroupsInternal(String groupId,
                                       Set<Group> groups)

getDirectParentGroups

protected List<Group> getDirectParentGroups(String groupId,
                                            org.joda.time.DateTime asOfDate)

getMembersOfGroup

public List<GroupMember> getMembersOfGroup(String groupId)
                                    throws RiceIllegalArgumentException

Description copied from interface: GroupService

Get all GroupMembers all the groups with a given group id.

The collection of GroupMembers will contain members for a the group in no defined order.

Specified by:

getMembersOfGroup in interface GroupService

Parameters:

groupId - Id of group

Returns:

Collection of GroupMembers.

Throws:

RiceIllegalArgumentException - if the groupId is null or blank

getMembersOfGroupWithDate

public List<GroupMember> getMembersOfGroupWithDate(String groupId,
                                                   org.joda.time.DateTime asOfDate)
                                            throws RiceIllegalArgumentException

Description copied from interface: GroupService

Get all GroupMembers all the groups with a given group id and asOfDate.

The collection of GroupMembers will contain members for a the group in no defined order. That were members at the specified time.

Specified by:

getMembersOfGroupWithDate in interface GroupService

Parameters:

groupId - Id of group

asOfDate - Date for historical record

Returns:

Collection of GroupMembers.

Throws:

RiceIllegalArgumentException - if the groupId is null or blank

getMemberIdsByType

protected List<String> getMemberIdsByType(Collection<GroupMember> members,
                                          MemberType memberType)

getGroupBo

protected GroupBo getGroupBo(String groupId)

getGroupMemberBo

protected GroupMemberBo getGroupMemberBo(String id)

getParentGroups

protected List<Group> getParentGroups(String groupId)
                               throws RiceIllegalArgumentException

Throws:

RiceIllegalArgumentException

getMemberPrincipalIdsInternal

protected List<String> getMemberPrincipalIdsInternal(String groupId,
                                                     Set<String> visitedGroupIds)

getDirectGroupsForPrincipal

protected Collection<Group> getDirectGroupsForPrincipal(String principalId)

getDirectGroupsForPrincipal

protected Collection<Group> getDirectGroupsForPrincipal(String principalId,
                                                        String namespaceCode,
                                                        org.joda.time.DateTime asOfDate)

addGroupToGroup

public boolean addGroupToGroup(String childId,
                               String parentId)
                        throws RiceIllegalArgumentException

Description copied from interface: GroupService

Adds the group with the id supplied in childId as a member of the group with the id supplied in parentId.

Specified by:

addGroupToGroup in interface GroupService

Parameters:

childId - Id of the Group to be added to the members of Parent

parentId - Id of the Group object to add the member to

Returns:

true if the member was added successfully.

Throws:

RiceIllegalArgumentException - if the childId, parentId is null or blank

addPrincipalToGroup

public boolean addPrincipalToGroup(String principalId,
                                   String groupId)
                            throws RiceIllegalArgumentException

Description copied from interface: GroupService

Add the principal with the given principalId as a member of the group with the given groupId.

Specified by:

addPrincipalToGroup in interface GroupService

Parameters:

principalId - Id of the Principal to be added to the members of the Parent Group

groupId - Id of the Group object to add the member to

Returns:

true if the member was added successfully.

Throws:

RiceIllegalArgumentException - if the principalId, groupId is null or blank

createGroup

public Group createGroup(Group group)
                  throws RiceIllegalArgumentException

Description copied from interface: GroupService

Creates a new group using the given Group.

This will attempt to create a new Group

Specified by:

createGroup in interface GroupService

Parameters:

group - The new group to be created

Returns:

a the Group that has been created.

Throws:

RiceIllegalArgumentException - if the group is null

updateGroup

public Group updateGroup(Group group)
                  throws RiceIllegalArgumentException

Description copied from interface: GroupService

Updates an existing group using the given Group.

This will attempt to update an existing Group. For this to return without exceptions, the passed in Group must have it's Id set and be a valid group that already exists.

Specified by:

updateGroup in interface GroupService

Parameters:

group - The group to be updated

Returns:

a the Group that has been updated.

Throws:

RiceIllegalArgumentException - if the group is null

updateGroup

public Group updateGroup(String groupId,
                         Group group)
                  throws RiceIllegalArgumentException

Description copied from interface: GroupService

Updates a group using the given Group.

This will attempt to update an existing group with data from the passed in group. If the passed in groupId and the group.id values are different this method will inactivate the old group and create a new group with the same members with the passed in groups properties.

Specified by:

updateGroup in interface GroupService

Parameters:

groupId - Id of the Group to be updated

group - Group object to use for update

Returns:

a the Group that has been updated.

Throws:

RiceIllegalArgumentException - if the group is null or the groupId is null or blank

createGroupMember

public GroupMember createGroupMember(GroupMember groupMember)
                              throws RiceIllegalArgumentException

Description copied from interface: GroupService

Creates a new group using the given GroupMember.

This will attempt to create a new GroupMember

Specified by:

createGroupMember in interface GroupService

Parameters:

groupMember - The new groupMember to be created

Returns:

a the GroupMember that has been created.

Throws:

RiceIllegalArgumentException - if the group is null

updateGroupMember

public GroupMember updateGroupMember(GroupMember groupMember)
                              throws RiceIllegalArgumentException

Description copied from interface: GroupService

Updates an existing group using the given GroupMember.

This will attempt to update an existing GroupMember. For this to return without exceptions, the passed in GroupMember must have it's Id set and be a valid groupMember that already exists.

Specified by:

updateGroupMember in interface GroupService

Parameters:

groupMember - The groupMember to be updated

Returns:

a the GroupMember that has been updated.

Throws:

RiceIllegalArgumentException - if the groupMember is null

removeAllMembers

public void removeAllMembers(String groupId)
                      throws RiceIllegalArgumentException

Description copied from interface: GroupService

Removes all members from the group with the given groupId.

Specified by:

removeAllMembers in interface GroupService

Parameters:

groupId - Id of the Group object to remove the members from

Throws:

RiceIllegalArgumentException - if the groupId is null or blank

removeGroupFromGroup

public boolean removeGroupFromGroup(String childId,
                                    String parentId)
                             throws RiceIllegalArgumentException

Description copied from interface: GroupService

Removes the group with the id supplied in childId from the group with the id supplied in parentId.

Specified by:

removeGroupFromGroup in interface GroupService

Parameters:

childId - Id of the Group to be removed from the members of Parent

parentId - Id of the Group object to remove the member from

Returns:

true if the member was removed successfully.

Throws:

RiceIllegalArgumentException - if the childId, parentId is null or blank

removePrincipalFromGroup

public boolean removePrincipalFromGroup(String principalId,
                                        String groupId)
                                 throws RiceIllegalArgumentException

Description copied from interface: GroupService

Removes the member principal with the given principalId from the group with the given groupId.

Specified by:

removePrincipalFromGroup in interface GroupService

Parameters:

principalId - Id of the Principal to be removed from the members of the Parent Group

groupId - Id of the Group object to remove the member from

Returns:

true if the member was removed successfully.

Throws:

RiceIllegalArgumentException - if the principalId, groupId is null or blank

saveGroup

protected GroupBo saveGroup(GroupBo group)

setDataObjectService

public void setDataObjectService(DataObjectService dataObjectService)