Package org.craftercms.studio.api.v2.dal
Interface GroupDAO
-
public interface GroupDAO
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Integer
addGroupMembers(long groupId, List<Long> userIds)
Add users to the groupInteger
createGroup(long orgId, String groupName, String groupDescription, int externallyManaged)
Create groupInteger
deleteGroup(long groupId)
Delete groupInteger
deleteGroups(List<Long> groupIds)
Delete groupsList<Group>
getAllGroupsForOrganization(long orgId, String keyword, int offset, int limit, String sort)
Get all groups for given organizationint
getAllGroupsForOrganizationTotal(long orgId, String keyword)
Get all groups for given organizationGroup
getGroup(long groupId)
Get group by group idGroup
getGroupByName(String groupName)
Get group by group nameList<User>
getGroupMembers(long groupId, int offset, int limit, String sort)
Get group membersInteger
getGroupMembersTotal(long groupId)
Get total number of group members.List<Group>
getGroups(List<Long> groupIds)
Get groups by group idsInteger
groupExists(long groupId, String groupName)
Check if group existsInteger
removeGroupMembers(long groupId, List<Long> userIds)
Remove users from the groupInteger
updateGroup(Group group)
Update group
-
-
-
Method Detail
-
getAllGroupsForOrganization
List<Group> getAllGroupsForOrganization(@Param("orgId") long orgId, @Param("keyword") String keyword, @Param("offset") int offset, @Param("limit") int limit, @Param("sort") String sort)
Get all groups for given organization- Parameters:
orgId
- organization identifierkeyword
- keyword to filter groupsoffset
- offset fpr paginationlimit
- limit number of groups per pagesort
- sort order- Returns:
- List of groups
-
getAllGroupsForOrganizationTotal
int getAllGroupsForOrganizationTotal(@Param("orgId") long orgId, @Param("keyword") String keyword)
Get all groups for given organization- Parameters:
orgId
- organization identifierkeyword
- keyword to filter groups- Returns:
- List of groups
-
createGroup
Integer createGroup(@Param("orgId") long orgId, @Param("groupName") String groupName, @Param("groupDescription") String groupDescription, @Param("externallyManaged") int externallyManaged)
Create group- Parameters:
orgId
- organization idgroupName
- group namegroupDescription
- group descriptionexternallyManaged
- 1 if group is externally managed, 0 otherwise- Returns:
- Number of affected rows in DB
-
updateGroup
Integer updateGroup(Group group)
Update group- Parameters:
group
- group to update- Returns:
- Number of affected rows in DB
-
deleteGroup
Integer deleteGroup(@Param("groupId") long groupId)
Delete group- Parameters:
groupId
- group identifier- Returns:
- Number of affected rows in DB
-
deleteGroups
Integer deleteGroups(@Param("groupIds") List<Long> groupIds)
Delete groups- Parameters:
groupIds
- ids of the groups to be deleted- Returns:
- Number of affected rows in DB
-
getGroup
Group getGroup(@Param("groupId") long groupId)
Get group by group id- Parameters:
groupId
- group identifier- Returns:
- Group or null if not found
-
getGroups
List<Group> getGroups(@Param("groupIds") List<Long> groupIds)
Get groups by group ids- Parameters:
groupIds
- list of group identifiers- Returns:
- List of groups or null if not found
-
getGroupByName
Group getGroupByName(@Param("groupName") String groupName)
Get group by group name- Parameters:
groupName
- group name- Returns:
- Group or null if not found
-
getGroupMembers
List<User> getGroupMembers(@Param("groupId") long groupId, @Param("offset") int offset, @Param("limit") int limit, @Param("sort") String sort)
Get group members- Parameters:
groupId
- group identifieroffset
- offset for paginationlimit
- limit number of members per pagesort
- sort order- Returns:
- List of users, group members
-
getGroupMembersTotal
Integer getGroupMembersTotal(@Param("groupId") long groupId)
Get total number of group members.- Parameters:
groupId
- group identifier- Returns:
- Number of members
-
addGroupMembers
Integer addGroupMembers(@Param("groupId") long groupId, @Param("userIds") List<Long> userIds)
Add users to the group- Parameters:
groupId
- group identifieruserIds
- list of user identifiers- Returns:
- Number of rows affected in DB
-
removeGroupMembers
Integer removeGroupMembers(@Param("groupId") long groupId, @Param("userIds") List<Long> userIds)
Remove users from the group- Parameters:
groupId
- group identifieruserIds
- list of user identifiers- Returns:
- Number of rows affected in DB
-
-