Package org.craftercms.studio.api.v2.service.security

Interface GroupService

All Known Implementing Classes:

GroupServiceImpl

public interface GroupService

Method Summary

Modifier and Type	Method	Description
List<User>	addGroupMembers(long groupId, List<Long> userIds, List<String> usernames)	Add users to the group
Group	createGroup(long orgId, String groupName, String groupDescription, boolean externallyManaged)	Create group
void	deleteGroup(List<Long> groupIds)	Delete group(s)
List<Group>	getAllGroups(long orgId, String keyword, int offset, int limit, String sort)	Get all groups
int	getAllGroupsTotal(long orgId, String keyword)	Get total number of all groups
Group	getGroup(long groupId)	Get group
List<User>	getGroupMembers(long groupId, int offset, int limit, String sort)	Get group members
int	getGroupMembersTotal(long groupId)	Get total number of group members
void	removeGroupMembers(long groupId, List<Long> userIds, List<String> usernames)	Remove users from the group
Group	updateGroup(long orgId, Group group)	Update group

Method Detail

getAllGroups

List<Group> getAllGroups(long orgId,
                         String keyword,
                         int offset,
                         int limit,
                         String sort)
                  throws ServiceLayerException,
                         OrganizationNotFoundException

Get all groups

Parameters:

keyword - keyword to filter groups

orgId - Organization identifier

offset - Result set offset

limit - Result set limit

sort - Sort order

Returns:

List of groups

Throws:

ServiceLayerException - general service error

OrganizationNotFoundException - organization not found

getAllGroupsTotal

int getAllGroupsTotal(long orgId,
                      String keyword)
               throws ServiceLayerException,
                      OrganizationNotFoundException

Get total number of all groups

Parameters:

keyword - keyword to filter groups

orgId - Organization identifier

Returns:

Number of groups

Throws:

ServiceLayerException - general service error

OrganizationNotFoundException - organization not found

createGroup

Group createGroup(long orgId,
                  String groupName,
                  String groupDescription,
                  boolean externallyManaged)
           throws GroupAlreadyExistsException,
                  ServiceLayerException,
                  AuthenticationException

Create group

Parameters:

orgId - Organization identifier

groupName - Group name

groupDescription - Group description

externallyManaged - true if group is externally managed, false otherwise

Returns:

the created group

Throws:

GroupAlreadyExistsException - group already exist error

ServiceLayerException - general service error

AuthenticationException - authentication error

updateGroup

Group updateGroup(long orgId,
                  Group group)
           throws ServiceLayerException,
                  GroupNotFoundException,
                  AuthenticationException,
                  GroupExternallyManagedException

Update group

Parameters:

orgId - Organization identifier

group - Group to update

Returns:

the updated group

Throws:

ServiceLayerException - general service error

GroupNotFoundException - group not found error

AuthenticationException - authentication error

GroupExternallyManagedException - if group is externally managed

deleteGroup

void deleteGroup(List<Long> groupIds)
          throws ServiceLayerException,
                 GroupNotFoundException,
                 AuthenticationException,
                 GroupExternallyManagedException

Delete group(s)

Parameters:

groupIds - Group identifiers

Throws:

ServiceLayerException - general service error

GroupNotFoundException - group not found

AuthenticationException - authentication error

GroupExternallyManagedException - if group is externally managed

getGroup

Group getGroup(long groupId)
        throws ServiceLayerException,
               GroupNotFoundException

Get group

Parameters:

groupId - Group identifier

Returns:

Group

Throws:

ServiceLayerException - general service error

GroupNotFoundException - group not found

getGroupMembers

List<User> getGroupMembers(long groupId,
                           int offset,
                           int limit,
                           String sort)
                    throws ServiceLayerException,
                           GroupNotFoundException

Get group members

Parameters:

groupId - Group identifier

offset - Result set offset

limit - Result set limit

sort - Sort order

Returns:

List of users

Throws:

ServiceLayerException - general service error

GroupNotFoundException - group not found

getGroupMembersTotal

int getGroupMembersTotal(long groupId)
                  throws ServiceLayerException,
                         GroupNotFoundException

Get total number of group members

Parameters:

groupId - Group identifier

Returns:

Number of members

Throws:

ServiceLayerException - general service error

GroupNotFoundException - group not found

addGroupMembers

List<User> addGroupMembers(long groupId,
                           List<Long> userIds,
                           List<String> usernames)
                    throws ServiceLayerException,
                           UserNotFoundException,
                           GroupNotFoundException,
                           AuthenticationException

Add users to the group

Parameters:

groupId - Group identifier

userIds - List of user identifiers

usernames - List of usernames

Returns:

users added to the group

Throws:

ServiceLayerException - general service error

UserNotFoundException - user not found

GroupNotFoundException - group not found

AuthenticationException - authentication error

removeGroupMembers

void removeGroupMembers(long groupId,
                        List<Long> userIds,
                        List<String> usernames)
                 throws ServiceLayerException,
                        UserNotFoundException,
                        GroupNotFoundException,
                        AuthenticationException

Remove users from the group

Parameters:

groupId - Group identifier

userIds - List of user identifiers

usernames - List of usernames

Throws:

ServiceLayerException - general service error

UserNotFoundException - user not found

GroupNotFoundException - group not found

AuthenticationException - authentication error