org.jbei.ice.lib.group

Class Groups

java.lang.Object

org.jbei.ice.lib.group.Groups

public class Groups
extends Object

Groups of users with methods for manipulation (and access)

Author:

Hector Plahar

Constructor Summary

Constructors

Constructor and Description
Groups(String userId)

Method Summary

Modifier and Type	Method and Description
UserGroup	addGroup(UserGroup userGroup) Adds group to the list of groups for current user
Results<UserGroup>	get(GroupType groupType, int offset, int limit)
Results<UserGroup>	get(long userId) Retrieves groups that user is either a member of.
UserGroup	getGroupMembers(long groupId) Retrieves both local and remote members of the specified group if the user making the request has the appropriate permissions
List<UserGroup>	getMatchingGroups(String token, int limit)
protected void	setGroupMembers(Group group, List<AccountTransfer> members, List<RemoteUser> remoteUsers)
boolean	update(long groupId, UserGroup userGroup)

Methods inherited from class java.lang.Object

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

Constructor Detail

Groups

public Groups(String userId)

Method Detail

get

public Results<UserGroup> get(long userId)

Retrieves groups that user is either a member of. Users are implicit members of the groups that they create so call also returns those groups

Parameters:

userId - id of account whose groups are being requested

Returns:

list of groups that user is a member of

get

public Results<UserGroup> get(GroupType groupType,
                              int offset,
                              int limit)

getMatchingGroups

public List<UserGroup> getMatchingGroups(String token,
                                         int limit)

addGroup

public UserGroup addGroup(UserGroup userGroup)

Adds group to the list of groups for current user

Parameters:

userGroup - information about group to be added, including members (local and remote)

Returns:

added group

getGroupMembers

public UserGroup getGroupMembers(long groupId)

Retrieves both local and remote members of the specified group if the user making the request has the appropriate permissions

Parameters:

groupId - unique local identifier of group

Returns:

information about specified group including remote and local members

Throws:

PermissionException - if the user does not have read permissions

update

public boolean update(long groupId,
                      UserGroup userGroup)

setGroupMembers

protected void setGroupMembers(Group group,
                               List<AccountTransfer> members,
                               List<RemoteUser> remoteUsers)