org.assistments.service.manager.core.impl

Class GroupManagerImpl

java.lang.Object

org.assistments.service.manager.content.impl.ManagerHelperImpl<Group>

org.assistments.service.manager.core.impl.GroupManagerImpl

All Implemented Interfaces:

GroupManager, ManagerHelper<Group>

@Component
public class GroupManagerImpl
extends ManagerHelperImpl<Group>
implements GroupManager

Constructor Summary

Constructors

Constructor and Description
GroupManagerImpl()

Method Summary

Modifier and Type	Method and Description
void	addMember(XInfo groupXinfo, XInfo memberXinfo) Add an ASSISTments Principal to a Group.
void	deactivateGroup(XInfo groupXinfo) Deactivate a Group.
Group	getGroup(XInfo groupXinfo) Returns a requested Group
java.util.List<XInfo>	getOwnedGroups(java.lang.String appRef) Returns a list of Groups owned by the specified application.
java.util.List<XInfo>	getOwnedGroups(java.lang.String appRef, XInfo ownerXinfo) Returns a list of Groups owned by a user.
java.util.List<Group>	getOwnedGroups(XInfo ownerXinfo) Returns a list of Groups owned by a user.
java.util.List<XInfo>	getParentGroups(XInfo memberXinfo) Returns a list of Groups containing a specified member - be it a User or a Group member.
Group	persist(Group group) Creates a new Group for a particular application
Group	persist(java.lang.String groupName, User groupOwner)
void	removeMember(XInfo groupXinfo, XInfo memberXinfo) Removes an ASSISTments Principal from a Group.
void	renameGroup(XInfo xinfo, java.lang.String newName) Renames a Group.
(package private) GroupRow	toGroupRow(Group g)

Methods inherited from class org.assistments.service.manager.content.impl.ManagerHelperImpl

createExternalReferenceFor

Methods inherited from class java.lang.Object

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

Constructor Detail

GroupManagerImpl

public GroupManagerImpl()

Method Detail

persist

@Transactional
public Group persist(java.lang.String groupName,
                                     User groupOwner)

Specified by:

persist in interface GroupManager

persist

public Group persist(Group group)

Description copied from interface: GroupManager

Creates a new Group for a particular application

If group does not contain a name, the SDK generates one.
If group contains members, those are

Specified by:

persist in interface GroupManager

Returns:

The group updated with the its database ID

toGroupRow

GroupRow toGroupRow(Group g)

getGroup

@Transactional
public Group getGroup(XInfo groupXinfo)

Description copied from interface: GroupManager

Returns a requested Group

Specified by:

getGroup in interface GroupManager

Parameters:

groupXinfo - A Group's external identifier information

Returns:

The Group

renameGroup

public void renameGroup(XInfo xinfo,
                        java.lang.String newName)

Description copied from interface: GroupManager

Renames a Group.

Specified by:

renameGroup in interface GroupManager

Parameters:

xinfo - A Group's external identifier information

newName - Group's new name

addMember

public void addMember(XInfo groupXinfo,
                      XInfo memberXinfo)

Description copied from interface: GroupManager

Add an ASSISTments Principal to a Group.

Specified by:

addMember in interface GroupManager

Parameters:

groupXinfo - Target Group's external identifier information

memberXinfo - External identifier information of the member to add

removeMember

public void removeMember(XInfo groupXinfo,
                         XInfo memberXinfo)
                  throws java.lang.IllegalArgumentException

Description copied from interface: GroupManager

Removes an ASSISTments Principal from a Group.

Specified by:

removeMember in interface GroupManager

Parameters:

groupXinfo - Target Group's external identifier information

memberXinfo - External identifier information of the member to remove

Throws:

java.lang.IllegalArgumentException

deactivateGroup

public void deactivateGroup(XInfo groupXinfo)

Description copied from interface: GroupManager

Deactivate a Group.

First deactivates all memberships of the Group, then deactivates the Group itself. Next deactivates the Group's membership in all other Groups.

deactivateGroup() does NOT recursively deactivate child Groups. To accomplish that, call this method explicitly for member Groups.

Specified by:

deactivateGroup in interface GroupManager

Parameters:

groupXinfo - A Group's external identifier information

getOwnedGroups

public java.util.List<XInfo> getOwnedGroups(java.lang.String appRef)

Description copied from interface: GroupManager

Returns a list of Groups owned by the specified application.

Specified by:

getOwnedGroups in interface GroupManager

Parameters:

appRef - The partner application's external reference

Returns:

A list of Pairs where each Pair element represents a single Group. The first member in the Pair is the external ID of the Group and the second member is the Group's external reference.

getOwnedGroups

public java.util.List<XInfo> getOwnedGroups(java.lang.String appRef,
                                            XInfo ownerXinfo)

Description copied from interface: GroupManager

Returns a list of Groups owned by a user.

Specified by:

getOwnedGroups in interface GroupManager

Parameters:

appRef - The partner application's external reference

ownerXinfo - The owner's external identifier information (a user)

Returns:

A list of Pairs where each Pair element represents a single Group. The first member in the Pair is the external ID of the Group and the second member is the Group's external reference.

getOwnedGroups

public java.util.List<Group> getOwnedGroups(XInfo ownerXinfo)

Description copied from interface: GroupManager

Returns a list of Groups owned by a user.

Specified by:

getOwnedGroups in interface GroupManager

Parameters:

ownerXinfo - The owner's external identifier information (a user)

Returns:

A list of Groups where each Group element represents a single Group.

getParentGroups

public java.util.List<XInfo> getParentGroups(XInfo memberXinfo)

Description copied from interface: GroupManager

Returns a list of Groups containing a specified member - be it a User or a Group member.

Specified by:

getParentGroups in interface GroupManager

Parameters:

memberXinfo - The member's external identifier information

Returns:

A list of external identifiers of the Groups containing memberXinfo.