Package org.exoplatform.social.core.jpa.storage.dao

Interface SpaceMemberDAO

All Superinterfaces:

org.exoplatform.commons.api.persistence.GenericDAO<SpaceMemberEntity,Long>

All Known Implementing Classes:

SpaceMemberDAOImpl

public interface SpaceMemberDAO
extends org.exoplatform.commons.api.persistence.GenericDAO<SpaceMemberEntity,Long>

Method Summary

Modifier and Type	Method	Description
default int	countDisabledSpaceMembers(Long spaceId)	Count disabled space members
default int	countExternalMembers(Long spaceId)	Counts the number of external users in a specific space
int	countPendingSpaceRequestsToManage(String username)
int	countSpaceMembers(Long spaceId, SpaceMemberEntity.Status status)	Count space members switch status
void	deleteBySpace(SpaceEntity entity)
default List<String>	getDisabledSpaceMembers(Long spaceId, int offset, int limit)	Get disabled space members
List<jakarta.persistence.Tuple>	getPendingSpaceRequestsToManage(String username, int offset, int limit)
default List<Long>	getSpaceIdByMemberId(String username, int offset, int limit)	Retrieves the list of Space technical identifiers
default List<Long>	getSpaceIdentityIdsByUserRole(String remoteId, SpaceMemberEntity.Status status, int offset, int limit)	Get space identity ids switch user status
default List<Long>	getSpaceIdsByUserRole(String username, SpaceMemberEntity.Status status, int offset, int limit)	Retrieves the list of Space technical identifiers switch status
List<String>	getSpaceMembers(Long spaceId, SpaceMemberEntity.Status status, int offset, int limit)	Get space members switch status
SpaceMemberEntity	getSpaceMemberShip(String remoteId, Long spaceId, SpaceMemberEntity.Status status)
List<Long>	getSpacesIdsByUserName(String userId, int offset, int limit)
List<String>	sortSpaceMembers(List<String> userNames, String sortField, String sortDirection, boolean filterDisabled)	Sort user identity remote ids

Methods inherited from interface org.exoplatform.commons.api.persistence.GenericDAO

count, create, createAll, delete, deleteAll, deleteAll, find, findAll, update, updateAll

Method Details

deleteBySpace

void deleteBySpace(SpaceEntity entity)

getSpaceMemberShip

SpaceMemberEntity getSpaceMemberShip(String remoteId,
 Long spaceId,
 SpaceMemberEntity.Status status)

getSpaceIdentityIdsByUserRole

default List<Long> getSpaceIdentityIdsByUserRole(String remoteId,
 SpaceMemberEntity.Status status,
 int offset,
 int limit)

Get space identity ids switch user status

Parameters:

remoteId - user Identity remote Id

status - equals to MEMBER, MANAGER, PENDING, INVITED or IGNORED

offset - The starting point

limit - limit of results to retrieve

Returns:

List of Space technical identifiers of type Long

getSpacesIdsByUserName

List<Long> getSpacesIdsByUserName(String userId,
 int offset,
 int limit)

getSpaceMembers

List<String> getSpaceMembers(Long spaceId,
 SpaceMemberEntity.Status status,
 int offset,
 int limit)

Get space members switch status

Parameters:

spaceId -

status - equals to MEMBER, MANAGER, PENDING, INVITED or IGNORED

offset -

limit -

Returns:

getDisabledSpaceMembers

default List<String> getDisabledSpaceMembers(Long spaceId,
 int offset,
 int limit)

Get disabled space members

Parameters:

spaceId - the space ID

offset - offset of the page

limit - number of elements on each page

Returns:

list of user names

getSpaceIdByMemberId

default List<Long> getSpaceIdByMemberId(String username,
 int offset,
 int limit)

Retrieves the list of Space technical identifiers

Parameters:

username - user remote id

offset - The starting point

limit - The limitation of returned results

Returns:

List of Space technical identifiers of type Long

getSpaceIdsByUserRole

default List<Long> getSpaceIdsByUserRole(String username,
 SpaceMemberEntity.Status status,
 int offset,
 int limit)

Retrieves the list of Space technical identifiers switch status

Parameters:

username - user remote id

status - equals to MEMBER, MANAGER, PENDING, INVITED or IGNORED

offset - The starting point

limit - The limitation of returned results

Returns:

List of Space technical identifiers of type Long

sortSpaceMembers

List<String> sortSpaceMembers(List<String> userNames,
 String sortField,
 String sortDirection,
 boolean filterDisabled)

Sort user identity remote ids

Parameters:

userNames -

sortField -

sortDirection -

filterDisabled -

Returns:

List of userNames sorted by sortField

countSpaceMembers

int countSpaceMembers(Long spaceId,
 SpaceMemberEntity.Status status)

Count space members switch status

Parameters:

spaceId -

status - equals to MEMBER, MANAGER, PENDING, INVITED or IGNORED

Returns:

countDisabledSpaceMembers

default int countDisabledSpaceMembers(Long spaceId)

Count disabled space members

Parameters:

spaceId - the spaceID

Returns:

the number of disabled space members

countPendingSpaceRequestsToManage

int countPendingSpaceRequestsToManage(String username)

Parameters:

username - username used to retrieve user spaces

Returns:

the count of users requested to join spaces that user manages

getPendingSpaceRequestsToManage

List<jakarta.persistence.Tuple> getPendingSpaceRequestsToManage(String username,
 int offset,
 int limit)

Parameters:

username - username used to retrieve user spaces

offset - offset of the query

limit - limit of the query

Returns:

List Tuple of users requested to join spaces that designated user (with userId parameter) manages

countExternalMembers

default int countExternalMembers(Long spaceId)

Counts the number of external users in a specific space

Parameters:

spaceId -

Returns:

counts the external members in the space