Blue Mind
Release 1.0

net.bluemind.core.api.services
Interface IGroup

All Known Implementing Classes:
GroupClient

public interface IGroup

Blue Mind group service interface


Method Summary
 void addGroupsMembers(AccessToken token, Group group, java.util.List<Group> groups)
          Add groups members to a group
 void addMember(AccessToken token, Group group, Group childGroup)
          Add group member to a group
 void addMember(AccessToken token, Group group, User user)
          Add user member to a group
 void addUsersMembers(AccessToken token, Group group, java.util.List<User> user)
          Add users members to a group
 Group create(AccessToken token, Group group)
          Create a new group
 Group createWithMembers(AccessToken token, Group g, java.util.Collection<DirectoryEntry> members)
          Create group and add members
 java.lang.String deleteGroup(AccessToken token, java.lang.Integer id)
          Delete group ID id
 ResultList<Group> find(AccessToken token, GroupQuery gq)
          Find group matching group query gq
 java.util.Set<java.lang.String> getDomainGroupsExtId(AccessToken at, int domainId)
          Get ext ID list of not archived domain groups
 Group getGroupFromId(AccessToken token, java.lang.Integer id)
          Get group from ID ID
 java.util.List<Group> getGroups(AccessToken token, GroupQuery gq)
          Get groups group members
 ResultList<DirectoryEntry> getMembers(AccessToken at, GroupQuery gq)
          Return user & public group members.
 ResultList<User> getUsers(AccessToken token, GroupQuery gq)
          Get users group members
 boolean isMember(AccessToken token, Group group, Group childGroup)
          Check if childGroup is member of group
 boolean isMember(AccessToken token, Group group, User user)
          Check if user is member of group
 void removeGroupsMembers(AccessToken token, Group group, java.util.List<Group> groups)
          Remove groups members from a group
 void removeMember(AccessToken token, Group group, Group childGroup)
          Remove group member from a group
 void removeMember(AccessToken token, Group group, User user)
          Remove user member from a group
 void removeMembers(AccessToken at, int groupId)
          Remove all members from group
 void removeUsersMembers(AccessToken token, Group group, java.util.List<User> user)
          Remove users members from a group
 Group update(AccessToken token, Group group)
          Update group
 void updateMembers(AccessToken at, Group g, java.util.Collection<DirectoryEntry> toAdd, java.util.Collection<DirectoryEntry> toRemove)
          Add & Remove a set of members from a group.
 

Method Detail

create

Group create(AccessToken token,
             Group group)
             throws AuthFault,
                    ServerFault
Create a new group

Parameters:
token - bm-core token
group - group to create
Returns:
created group
Throws:
AuthFault
ServerFault

update

Group update(AccessToken token,
             Group group)
             throws AuthFault,
                    ServerFault
Update group

Parameters:
token - bm-core token
group - updated group
Returns:
updated group
Throws:
AuthFault
ServerFault

deleteGroup

java.lang.String deleteGroup(AccessToken token,
                             java.lang.Integer id)
                             throws AuthFault,
                                    ServerFault
Delete group ID id

Parameters:
token - bm-core token
id - group ID to delete
Returns:
String deleted
Throws:
AuthFault
ServerFault

getGroupFromId

Group getGroupFromId(AccessToken token,
                     java.lang.Integer id)
                     throws AuthFault,
                            ServerFault
Get group from ID ID

Parameters:
token - bm-core token
id - group ID
Returns:
Group with ID id
Throws:
AuthFault
ServerFault

find

ResultList<Group> find(AccessToken token,
                       GroupQuery gq)
                       throws AuthFault,
                              ServerFault
Find group matching group query gq

Parameters:
token - bm-core token
gq - group query
Returns:
list of groups matching query
Throws:
AuthFault
ServerFault

createWithMembers

Group createWithMembers(AccessToken token,
                        Group g,
                        java.util.Collection<DirectoryEntry> members)
                        throws AuthFault,
                               ServerFault
Create group and add members

Parameters:
token - bm-core token
g - group to create
members - members list
Returns:
created group
Throws:
AuthFault
ServerFault

addMember

void addMember(AccessToken token,
               Group group,
               User user)
               throws AuthFault,
                      ServerFault
Add user member to a group

Parameters:
token - bm-core token
group - group to manage
user - user to add as group member
Throws:
AuthFault
ServerFault

addUsersMembers

void addUsersMembers(AccessToken token,
                     Group group,
                     java.util.List<User> user)
                     throws AuthFault,
                            ServerFault
Add users members to a group

Parameters:
token - bm-core token
group - group to manage
users - users to add as group members
Throws:
AuthFault
ServerFault

addMember

void addMember(AccessToken token,
               Group group,
               Group childGroup)
               throws AuthFault,
                      ServerFault
Add group member to a group

Parameters:
token - bm-core token
group - group to manage
group - group to add as group member
Throws:
AuthFault
ServerFault

addGroupsMembers

void addGroupsMembers(AccessToken token,
                      Group group,
                      java.util.List<Group> groups)
                      throws AuthFault,
                             ServerFault
Add groups members to a group

Parameters:
token - bm-core token
group - group to manage
groups - groups to add as group members
Throws:
AuthFault
ServerFault

removeMember

void removeMember(AccessToken token,
                  Group group,
                  User user)
                  throws AuthFault,
                         ServerFault
Remove user member from a group

Parameters:
token - bm-core token
group - group to manage
user - user to remove from members list
Throws:
AuthFault
ServerFault

removeUsersMembers

void removeUsersMembers(AccessToken token,
                        Group group,
                        java.util.List<User> user)
                        throws AuthFault,
                               ServerFault
Remove users members from a group

Parameters:
token - bm-core token
group - group to manage
users - users to remove from members list
Throws:
AuthFault
ServerFault

removeMember

void removeMember(AccessToken token,
                  Group group,
                  Group childGroup)
                  throws AuthFault,
                         ServerFault
Remove group member from a group

Parameters:
token - bm-core token
group - group to manage
group - group to remove from members list
Throws:
AuthFault
ServerFault

removeGroupsMembers

void removeGroupsMembers(AccessToken token,
                         Group group,
                         java.util.List<Group> groups)
                         throws AuthFault,
                                ServerFault
Remove groups members from a group

Parameters:
token - bm-core token
group - group to manage
groups - groups to remove from members list
Throws:
AuthFault
ServerFault

getUsers

ResultList<User> getUsers(AccessToken token,
                          GroupQuery gq)
                          throws AuthFault,
                                 ServerFault
Get users group members

Parameters:
token - bm-core token
gq - group query
Returns:
users members list
Throws:
AuthFault
ServerFault

getGroups

java.util.List<Group> getGroups(AccessToken token,
                                GroupQuery gq)
                                throws AuthFault,
                                       ServerFault
Get groups group members

Parameters:
token - bm-core token
gq - group query
Returns:
groups members list
Throws:
AuthFault
ServerFault

isMember

boolean isMember(AccessToken token,
                 Group group,
                 User user)
                 throws AuthFault,
                        ServerFault
Check if user is member of group

Parameters:
token - bm-core token
group - group to query
user - user to check
Returns:
True if user is member of group, false otherwise
Throws:
AuthFault
ServerFault

isMember

boolean isMember(AccessToken token,
                 Group group,
                 Group childGroup)
                 throws AuthFault,
                        ServerFault
Check if childGroup is member of group

Parameters:
token - bm-core token
group - group to query
childGroup - group to check
Returns:
True if childGroup is member of group, false otherwise
Throws:
AuthFault
ServerFault

getMembers

ResultList<DirectoryEntry> getMembers(AccessToken at,
                                      GroupQuery gq)
                                      throws AuthFault,
                                             ServerFault
Return user & public group members. Pagination is (not yet) supported. ExpandMembers is not supported.

Parameters:
at - bm-core token
gq - group query
Returns:
members list
Throws:
AuthFault
ServerFault

updateMembers

void updateMembers(AccessToken at,
                   Group g,
                   java.util.Collection<DirectoryEntry> toAdd,
                   java.util.Collection<DirectoryEntry> toRemove)
                   throws AuthFault,
                          ServerFault
Add & Remove a set of members from a group. Also updates the group.

Parameters:
at - bm-core token
g - group to manage
toAdd - members to add from group
toRemove - members to remove from group
Throws:
AuthFault
ServerFault

removeMembers

void removeMembers(AccessToken at,
                   int groupId)
                   throws AuthFault,
                          ServerFault
Remove all members from group

Parameters:
groupId - group ID
Throws:
AuthFault
ServerFault

getDomainGroupsExtId

java.util.Set<java.lang.String> getDomainGroupsExtId(AccessToken at,
                                                     int domainId)
                                                     throws AuthFault,
                                                            ServerFault
Get ext ID list of not archived domain groups

Parameters:
at - bm-core token
domainId - domain ID to get group ext ID list
Returns:
ext ID list of not archived domain groups
Throws:
AuthFault
ServerFault

Blue Mind
Release 1.0