org.assistments.service.manager.core

Interface GroupManager

All Known Implementing Classes:

GroupManagerImpl

public interface GroupManager

GroupManger defines the management of Group objects.

NOTES & CAUTIONS: TODO TODO TODO: This belongs at the Manager package level

• After calling #persist(GroupBuilder), the returned Group domain object contains several ID values set there by the GroupManger. Those values include external information (aka xinfo) contained in an XInfo, available by calling XInfoImpl.getXinfo(), as well as an internal database ID. How to use (or not) those IDs:

  XPair.xid

  The SDK guarantees an object's external ID to be valid for the length of a run of your application - under the assumption a restart of the SDK's persistence layer software results in a termination of your application. This means your application can use xids to identify and reference persisted objects during runtime. However, your application must not itself persist xid values.

  XPair.xref

  The SDK guarantees an object's external references to be valid and to uniquely identify persisted objects across application runs. Your application is free to use xref values to identify and reference persisted objects and your application may itself persist xref values.

  dbid

  The SDK makes no guarantees with regard to an object's internal database id. It may be inserted into persisted objects solely for the convenience of internal use by the SDK. While an application can view the dbid, it cannot modify the value. Under no circumstances should an application attempt to use an object's dbid. None of the Manager methods expect the dbid as a method parameter.

• A single domain object cannot be persisted multiple times. You must clone it.
• place holder

See Also:

ExternalReference, XInfo

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.

Method Detail

persist

@Transactional
Group persist(Group group)

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

Parameters:

builder - The Group to create

xOwnerId - The owner of the group

Returns:

The group updated with the its database ID

persist

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

getGroup

@Transactional
Group getGroup(XInfo groupXinfo)

Returns a requested Group

Parameters:

groupXinfo - A Group's external identifier information

Returns:

The Group

deactivateGroup

@Transactional
void deactivateGroup(XInfo groupXinfo)

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.

Parameters:

groupXinfo - A Group's external identifier information

renameGroup

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

Renames a Group.

Parameters:

xinfo - A Group's external identifier information

newName - Group's new name

addMember

void addMember(XInfo groupXinfo,
               XInfo memberXinfo)

Add an ASSISTments Principal to a Group.

Parameters:

groupXinfo - Target Group's external identifier information

memberXinfo - External identifier information of the member to add

removeMember

void removeMember(XInfo groupXinfo,
                  XInfo memberXinfo)

Removes an ASSISTments Principal from a Group.

Parameters:

groupXinfo - Target Group's external identifier information

memberXinfo - External identifier information of the member to remove

getOwnedGroups

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

Returns a list of Groups owned by the specified application.

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

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

Returns a list of Groups owned by a user.

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

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

Returns a list of Groups owned by a user.

Parameters:

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

Returns:

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

getParentGroups

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

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

Parameters:

memberXinfo - The member's external identifier information

Returns:

A list of external identifiers of the Groups containing memberXinfo.