edu.mit.stellar.api.group
Interface SGroupFactory

All Known Subinterfaces:

SGroupManager

public interface SGroupFactory

SGroupFactory

Version:

$Revision: 29988 $, $Date: 2008-02-09 22:10:42 -0500 (Sat, 09 Feb 2008) $

Author:

MIT Stellar team

Method Summary

java.lang.String	getGroupManagerId() Return the ID of this SGroupFactory
SGroup	getSGroupByGroupId(java.lang.String groupId) Return the group given the ID of the group within this Manager.
SGroup	getSGroupByGroupManagerIdAndGroupId(java.lang.String groupManagerId, java.lang.String groupId) Return the group given the ID of the group within the specified Manager.
java.util.Set<java.lang.String>	getSGroupIdsForUsername(java.lang.String username) Search for all groups for this user in this Manager or all Managers known to this Manager, return the GroupIds
java.util.Set<java.lang.String>	getSGroupIdsForUsername(java.lang.String username, boolean recursive) Search for all groups for this user in this Manager or all Managers known to this Manager.

Method Detail

getGroupManagerId

java.lang.String getGroupManagerId()

Return the ID of this SGroupFactory

Returns:

the ID

getSGroupByGroupId

SGroup getSGroupByGroupId(java.lang.String groupId)

Return the group given the ID of the group within this Manager.

Parameters:

groupId -

Returns:

getSGroupByGroupManagerIdAndGroupId

SGroup getSGroupByGroupManagerIdAndGroupId(java.lang.String groupManagerId,
                                           java.lang.String groupId)

Return the group given the ID of the group within the specified Manager. Throw an exception if the specified Manager is not known.

Parameters:

groupManagerId -

groupId -

Returns:

getSGroupIdsForUsername

java.util.Set<java.lang.String> getSGroupIdsForUsername(java.lang.String username)

Search for all groups for this user in this Manager or all Managers known to this Manager, return the GroupIds

Parameters:

username -

Returns:

getSGroupIdsForUsername

java.util.Set<java.lang.String> getSGroupIdsForUsername(java.lang.String username,
                                                        boolean recursive)

Search for all groups for this user in this Manager or all Managers known to this Manager. Return all groups recursively (that is, include parent groups of the group where the user is directly Seted) if recursive is true.

Parameters:

username -

Returns: