Package org.exoplatform.social.core.storage.api

Interface GroupSpaceBindingStorage

public interface GroupSpaceBindingStorage

Manage the storage (binding group space and space member binding information)

Method Summary

Modifier and Type	Method	Description
long	countBoundUsers(String spaceId)	Count the number of bound users in a space
long	countUserBindings(String spaceId, String userName)	Count user's bindings of the space.
GroupSpaceBindingQueue	createGroupSpaceBindingQueue(GroupSpaceBindingQueue bindingQueue)	Add a Group Space Binding to the binding queue
void	deleteAllUserBindings(String userName)	Delete all user bindings by username.
void	deleteGroupBinding(long id)	Deletes a binding by binding id.
void	deleteGroupBindingQueue(long id)	Deletes a binding by binding id.
void	deleteGroupBindingReport(long id)	Deletes a binding report by bindingReport id.
void	deleteGroupBindingReportUser(long id)	Deletes a binding report user by bindingReport id.
void	deleteUserBinding(long id)	Delete a user binding by binding id.
List<GroupSpaceBinding>	findAllGroupSpaceBinding()
List<GroupSpaceBindingQueue>	findAllGroupSpaceBindingQueue()
List<GroupSpaceBindingReportAction>	findAllGroupSpaceBindingReportAction()
List<GroupSpaceBindingReportUser>	findAllGroupSpaceBindingReportUser()
List<UserSpaceBinding>	findAllUserSpaceBinding()
List<UserSpaceBinding>	findBoundUsersByBindingId(long id)	Get a list containing UserSpaceBinding of a binding.
GroupSpaceBindingQueue	findFirstGroupSpaceBindingQueue()	Get the first GroupSpaceBindingQueue to treat
GroupSpaceBinding	findGroupSpaceBindingById(String bindingId)	Gets GroupSpaceBinding by Id.
GroupSpaceBindingReportAction	findGroupSpaceBindingReportAction(long bindingId, String action)
List<GroupSpaceBinding>	findGroupSpaceBindingsByGroup(String group)	Get a list containing all the groups binding for a space.
List<GroupSpaceBinding>	findGroupSpaceBindingsBySpace(String spaceId)	Get a list containing all the groups binding for a space.
List<GroupSpaceBindingReportUser>	findReportsForCsv(long spaceId, long groupSpaceBindingId, String group, String action)	Get the binding report for generate the csv file
List<UserSpaceBinding>	findUserAllBindingsByGroupBinding(GroupSpaceBinding binding)	Get all user bindings for a group
List<UserSpaceBinding>	findUserSpaceBindingsByGroup(String group, String userName)	Get a list containing all the group binding for a user (user/group).
List<UserSpaceBinding>	findUserSpaceBindingsBySpace(String spaceId, String userName)	Get a list containing all the group binding for a space member.
List<UserSpaceBinding>	findUserSpaceBindingsByUser(String userName)	Get a all the group binding for a user (user/group).
List<GroupSpaceBindingQueue>	getAllFromBindingQueue()
List<GroupSpaceBindingOperationReport>	getGroupSpaceBindingReportOperations()	Gets all the GroupSpaceBindingOperations Report.
List<GroupSpaceBindingOperationReport>	getGroupSpaceBindingReportOperations(String spaceId)
List<GroupSpaceBinding>	getGroupSpaceBindingsFromQueueByAction(String action)	Gets GroupSpaceBindings by action from the queue.
boolean	isBoundSpace(String spaceId)	Checks if the space has bindings by counting space's available bindings and space's bindings to be removed from the binding queue.
boolean	isUserBoundAndMemberBefore(String spaceId, String userId)	Checks if user is already bound and member of the space.
GroupSpaceBinding	saveGroupSpaceBinding(GroupSpaceBinding binding)	Saves a new binding.
GroupSpaceBindingReportAction	saveGroupSpaceBindingReport(GroupSpaceBindingReportAction groupSpaceBindingReportAction)	Saves a group space binding report.
void	saveGroupSpaceBindingReportUser(GroupSpaceBindingReportUser groupSpaceBindingReportUser)
UserSpaceBinding	saveUserBinding(UserSpaceBinding binding)	Saves a user binding.
void	updateGroupSpaceBindingReportAction(GroupSpaceBindingReportAction bindingReportAction)

Method Details

findFirstGroupSpaceBindingQueue

GroupSpaceBindingQueue findFirstGroupSpaceBindingQueue()
                                                throws GroupSpaceBindingStorageException

Get the first GroupSpaceBindingQueue to treat

Returns:

The GroupSpaceBindingQueue

Throws:

GroupSpaceBindingStorageException

findGroupSpaceBindingsBySpace

List<GroupSpaceBinding> findGroupSpaceBindingsBySpace(String spaceId)
                                               throws GroupSpaceBindingStorageException

Get a list containing all the groups binding for a space.

Parameters:

spaceId - The space Id.

Returns:

The list of binding.

Throws:

GroupSpaceBindingStorageException

findGroupSpaceBindingsByGroup

List<GroupSpaceBinding> findGroupSpaceBindingsByGroup(String group)
                                               throws GroupSpaceBindingStorageException

Get a list containing all the groups binding for a space.

Parameters:

group - The group Id.

Returns:

The list of binding.

Throws:

GroupSpaceBindingStorageException

findUserSpaceBindingsBySpace

List<UserSpaceBinding> findUserSpaceBindingsBySpace(String spaceId,
 String userName)
                                             throws GroupSpaceBindingStorageException

Get a list containing all the group binding for a space member.

Parameters:

spaceId - The space Id.

userName - The space member.

Returns:

The list of binding.

Throws:

GroupSpaceBindingStorageException

findUserSpaceBindingsByGroup

List<UserSpaceBinding> findUserSpaceBindingsByGroup(String group,
 String userName)
                                             throws GroupSpaceBindingStorageException

Get a list containing all the group binding for a user (user/group).

Parameters:

group - The group.

userName - The space member.

Returns:

The list of binding.

Throws:

GroupSpaceBindingStorageException

findUserSpaceBindingsByUser

List<UserSpaceBinding> findUserSpaceBindingsByUser(String userName)
                                            throws GroupSpaceBindingStorageException

Get a all the group binding for a user (user/group).

Parameters:

userName - The group.

Returns:

The list of binding.

Throws:

GroupSpaceBindingStorageException

findUserAllBindingsByGroupBinding

List<UserSpaceBinding> findUserAllBindingsByGroupBinding(GroupSpaceBinding binding)
                                                  throws GroupSpaceBindingStorageException

Get all user bindings for a group

Parameters:

binding - the group binding

Returns:

A list of group bindings

Throws:

GroupSpaceBindingStorageException

saveGroupSpaceBinding

GroupSpaceBinding saveGroupSpaceBinding(GroupSpaceBinding binding)
                                 throws GroupSpaceBindingStorageException

Saves a new binding.

Parameters:

binding -

Throws:

GroupSpaceBindingStorageException

createGroupSpaceBindingQueue

GroupSpaceBindingQueue createGroupSpaceBindingQueue(GroupSpaceBindingQueue bindingQueue)
                                             throws GroupSpaceBindingStorageException

Add a Group Space Binding to the binding queue

Parameters:

bindingQueue -

Throws:

GroupSpaceBindingStorageException

saveUserBinding

UserSpaceBinding saveUserBinding(UserSpaceBinding binding)
                          throws GroupSpaceBindingStorageException

Saves a user binding. binding an saves it.

Parameters:

binding -

Throws:

GroupSpaceBindingStorageException

saveGroupSpaceBindingReport

GroupSpaceBindingReportAction saveGroupSpaceBindingReport(GroupSpaceBindingReportAction groupSpaceBindingReportAction)
                                                   throws GroupSpaceBindingStorageException

Saves a group space binding report.

Parameters:

groupSpaceBindingReportAction -

Throws:

GroupSpaceBindingStorageException

deleteGroupBinding

void deleteGroupBinding(long id)
                 throws GroupSpaceBindingStorageException

Deletes a binding by binding id.

Parameters:

id -

Throws:

GroupSpaceBindingStorageException

deleteGroupBindingReport

void deleteGroupBindingReport(long id)
                       throws GroupSpaceBindingStorageException

Deletes a binding report by bindingReport id.

Parameters:

id -

Throws:

GroupSpaceBindingStorageException

deleteGroupBindingReportUser

void deleteGroupBindingReportUser(long id)
                           throws GroupSpaceBindingStorageException

Deletes a binding report user by bindingReport id.

Parameters:

id -

Throws:

GroupSpaceBindingStorageException

deleteGroupBindingQueue

void deleteGroupBindingQueue(long id)
                      throws GroupSpaceBindingStorageException

Deletes a binding by binding id.

Parameters:

id -

Throws:

GroupSpaceBindingStorageException

deleteUserBinding

void deleteUserBinding(long id)
                throws GroupSpaceBindingStorageException

Delete a user binding by binding id.

Parameters:

id -

Throws:

GroupSpaceBindingStorageException

deleteAllUserBindings

void deleteAllUserBindings(String userName)
                    throws GroupSpaceBindingStorageException

Delete all user bindings by username.

Parameters:

userName -

Throws:

GroupSpaceBindingStorageException

countUserBindings

long countUserBindings(String spaceId,
 String userName)
                throws GroupSpaceBindingStorageException

Count user's bindings of the space.

Parameters:

spaceId - The space Id.

userName -

Returns:

number of UserSpaceBinding

Throws:

GroupSpaceBindingStorageException

findBoundUsersByBindingId

List<UserSpaceBinding> findBoundUsersByBindingId(long id)
                                          throws GroupSpaceBindingStorageException

Get a list containing UserSpaceBinding of a binding.

Parameters:

id -

Returns:

a list of UserSpaceBindings

Throws:

GroupSpaceBindingStorageException

isUserBoundAndMemberBefore

boolean isUserBoundAndMemberBefore(String spaceId,
 String userId)

Checks if user is already bound and member of the space.

Parameters:

spaceId -

userId -

Returns:

findGroupSpaceBindingById

GroupSpaceBinding findGroupSpaceBindingById(String bindingId)

Gets GroupSpaceBinding by Id.

Parameters:

bindingId -

Returns:

getGroupSpaceBindingsFromQueueByAction

List<GroupSpaceBinding> getGroupSpaceBindingsFromQueueByAction(String action)

Gets GroupSpaceBindings by action from the queue.

Parameters:

action -

Returns:

isBoundSpace

boolean isBoundSpace(String spaceId)

Checks if the space has bindings by counting space's available bindings and space's bindings to be removed from the binding queue.

Parameters:

spaceId -

Returns:

countBoundUsers

long countBoundUsers(String spaceId)

Count the number of bound users in a space

Parameters:

spaceId -

Returns:

number of bound users

findReportsForCsv

List<GroupSpaceBindingReportUser> findReportsForCsv(long spaceId,
 long groupSpaceBindingId,
 String group,
 String action)

Get the binding report for generate the csv file

Parameters:

spaceId -

groupSpaceBindingId -

group -

action -

Returns:

getGroupSpaceBindingReportOperations

List<GroupSpaceBindingOperationReport> getGroupSpaceBindingReportOperations()

Gets all the GroupSpaceBindingOperations Report.

Returns:

getGroupSpaceBindingReportOperations

List<GroupSpaceBindingOperationReport> getGroupSpaceBindingReportOperations(String spaceId)

saveGroupSpaceBindingReportUser

void saveGroupSpaceBindingReportUser(GroupSpaceBindingReportUser groupSpaceBindingReportUser)

updateGroupSpaceBindingReportAction

void updateGroupSpaceBindingReportAction(GroupSpaceBindingReportAction bindingReportAction)

findGroupSpaceBindingReportAction

GroupSpaceBindingReportAction findGroupSpaceBindingReportAction(long bindingId,
 String action)

getAllFromBindingQueue

List<GroupSpaceBindingQueue> getAllFromBindingQueue()

findAllGroupSpaceBinding

List<GroupSpaceBinding> findAllGroupSpaceBinding()

findAllUserSpaceBinding

List<UserSpaceBinding> findAllUserSpaceBinding()

findAllGroupSpaceBindingQueue

List<GroupSpaceBindingQueue> findAllGroupSpaceBindingQueue()

findAllGroupSpaceBindingReportAction

List<GroupSpaceBindingReportAction> findAllGroupSpaceBindingReportAction()

findAllGroupSpaceBindingReportUser

List<GroupSpaceBindingReportUser> findAllGroupSpaceBindingReportUser()