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<UserResponse>	addGroupMembers(long groupId, List<Long> userIds, List<String> usernames, boolean externallyManaged)	Add users to the group
Group	createGroup(String groupName, String groupDescription, boolean externallyManaged)	Create group
void	deleteGroup(List<Long> groupIds)	Delete group(s)
List<Group>	getAllGroups(String keyword, int offset, int limit, String sort)	Get all groups
int	getAllGroupsTotal(String keyword)	Get total number of all groups
Group	getGroup(long groupId)	Get group
List<UserResponse>	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(Group group)	Update group

Method Details

getAllGroups

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

Get all groups

Parameters:

keyword - keyword to filter groups

offset - Result set offset

limit - Result set limit

sort - Sort order

Returns:

List of groups

Throws:

ServiceLayerException - general service error

getAllGroupsTotal

int getAllGroupsTotal(String keyword)
               throws ServiceLayerException

Get total number of all groups

Parameters:

keyword - keyword to filter groups

Returns:

Number of groups

Throws:

ServiceLayerException - general service error

createGroup

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

Create group

Parameters:

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(Group group)
           throws ServiceLayerException,
GroupNotFoundException,
AuthenticationException,
GroupExternallyManagedException

Update group

Parameters:

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<UserResponse> 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<UserResponse> addGroupMembers(long groupId,
 List<Long> userIds,
 List<String> usernames,
 boolean externallyManaged)
                            throws ServiceLayerException,
UserNotFoundException,
GroupNotFoundException,
AuthenticationException

Add users to the group

Parameters:

groupId - Group identifier

userIds - List of user identifiers

usernames - List of usernames

externallyManaged - true if group is externally managed, false otherwise

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