org.bonitasoft.engine.api

Interface MembershipAPI

All Known Subinterfaces:

IdentityAPI, IdentityAPI

public interface MembershipAPI

MembershipAPI forms part of the OrganizationAPI and gives access to all the Administration operations available on UserMemberships: creation, deletion, updating, retrieval, etc...

Author:

Matthieu Chaffotte, Emmanuel Duchastenier

See Also:

UserMembership

Method Summary

Methods

Modifier and Type	Method and Description
UserMembership	addUserMembership(long userId, long groupId, long roleId) Associates the user with the group and the role.
void	addUserMemberships(List<Long> userIds, long groupId, long roleId) Associates the users with the group and the role.
void	deleteUserMembership(long userMembershipId) Deletes the user membership.
void	deleteUserMembership(long userId, long groupId, long roleId) Deletes the user membership.
void	deleteUserMemberships(List<Long> userIds, long groupId, long roleId) Deletes the user memberships.
long	getNumberOfUserMemberships(long userId) Returns the total number of memberships of the user.
UserMembership	getUserMembership(long membershipId) Retrieves the user membership.
List<UserMembership>	getUserMemberships(long userId, int startIndex, int maxResults, UserMembershipCriterion criterion) Retrieves the paginated list of user memberships of the user.
List<UserMembership>	getUserMembershipsByGroup(long groupId, int startIndex, int maxResults) Retrieves the paginated list of user memberships of the group.
List<UserMembership>	getUserMembershipsByRole(long roleId, int startIndex, int maxResults) Retrieves the paginated list of user memberships of the role.
UserMembership	updateUserMembership(long userMembershipId, long newGroupId, long newRoleId) Changes the association of the user membership.

Method Detail

addUserMembership

UserMembership addUserMembership(long userId,
                               long groupId,
                               long roleId)
                                 throws AlreadyExistsException,
                                        CreationException

Associates the user with the group and the role. The association is called a user membership.

Parameters:

userId - the identifier of the user

groupId - the identifier of the group

roleId - the identifier of the role

Returns:

the user membership

Throws:

AlreadyExistsException - If the triplet userId/groupId/roleId is already taken by an existing user membership

CreationException - If an exception occurs during the user membership creation

InvalidSessionException - If the session is invalid (expired, unknown, ...)

Since:

6.0

addUserMemberships

void addUserMemberships(List<Long> userIds,
                      long groupId,
                      long roleId)
                        throws AlreadyExistsException,
                               CreationException

Associates the users with the group and the role. The association is called a user membership.

Parameters:

userIds - the identifiers of the users

groupId - the identifier of the group

roleId - the identifier of the role

Throws:

AlreadyExistsException - If the triplet userId/groupId/roleId is already taken by an existing user membership

CreationException - If an exception occurs during the user membership creation

InvalidSessionException - If the session is invalid (expired, unknown, ...)

Since:

6.0

updateUserMembership

UserMembership updateUserMembership(long userMembershipId,
                                  long newGroupId,
                                  long newRoleId)
                                    throws MembershipNotFoundException,
                                           UpdateException

Changes the association of the user membership. It associates the user membership to the new role and group identifiers.

Parameters:

userMembershipId - the identifier of the user membership

newGroupId - the identifier of the new group

newRoleId - the identifier of the new role

Returns:

the updated user membership

Throws:

MembershipNotFoundException - If the identifier of the user membership does not refer to an existing user membership

UpdateException - If an exception occurs during the user membership update

InvalidSessionException - If the session is invalid (expired, unknown, ...)

Since:

6.0

deleteUserMembership

void deleteUserMembership(long userMembershipId)
                          throws DeletionException

Deletes the user membership.

Parameters:

userMembershipId - the identifier of the user membership

Throws:

DeletionException - If an exception occurs during the user membership deletion

InvalidSessionException - If the session is invalid (expired, unknown, ...)

Since:

6.0

deleteUserMembership

void deleteUserMembership(long userId,
                        long groupId,
                        long roleId)
                          throws DeletionException

Deletes the user membership.

Parameters:

userId - the identifier of the user

groupId - the identifier of the group

roleId - the identifier of the role

Throws:

DeletionException - If an exception occurs during the user membership deletion

InvalidSessionException - If the session is invalid (expired, unknown, ...)

Since:

6.0

deleteUserMemberships

void deleteUserMemberships(List<Long> userIds,
                         long groupId,
                         long roleId)
                           throws DeletionException

Deletes the user memberships.

Parameters:

userIds - the identifiers of the users

groupId - the identifier of the group

roleId - the identifier of the role

Throws:

DeletionException - If an exception occurs during the user membership deletion

InvalidSessionException - If the session is invalid (expired, unknown, ...)

Since:

6.0

getUserMembership

UserMembership getUserMembership(long membershipId)
                                 throws MembershipNotFoundException

Retrieves the user membership.

Parameters:

membershipId - the identifier of the user membership to retrieve.

Returns:

the found UserMembership with the provided id

Throws:

MembershipNotFoundException - If the identifier of the user membership does not refer to an existing user membership

RetrieveException - If an exception occurs during the user membership retrieving

InvalidSessionException - If the session is invalid (expired, unknown, ...)

getNumberOfUserMemberships

long getNumberOfUserMemberships(long userId)

Returns the total number of memberships of the user.

Parameters:

userId - the identifier of the user

Returns:

the total number of memberships of the user

Throws:

RetrieveException - If an exception occurs during the count retrieving

InvalidSessionException - If the session is invalid (expired, unknown, ...)

getUserMemberships

List<UserMembership> getUserMemberships(long userId,
                                      int startIndex,
                                      int maxResults,
                                      UserMembershipCriterion criterion)

Retrieves the paginated list of user memberships of the user. It retrieves from the startIndex to the startIndex + maxResults.

Parameters:

userId - the identifier of the user

startIndex - the start index

maxResults - the max number of user memberships

criterion - the sorting criterion

Returns:

the paginated list of user memberships

Throws:

RetrieveException - If an exception occurs during the count retrieving

InvalidSessionException - If the session is invalid (expired, unknown, ...)

Since:

6.0

getUserMembershipsByGroup

List<UserMembership> getUserMembershipsByGroup(long groupId,
                                             int startIndex,
                                             int maxResults)

Retrieves the paginated list of user memberships of the group. It retrieves from the startIndex to the startIndex + maxResults.

Parameters:

groupId - the identifier of the group

startIndex - the start index

maxResults - the max number of user memberships

Returns:

the paginated list of user memberships

Throws:

RetrieveException - If an exception occurs during the count retrieving

InvalidSessionException - If the session is invalid (expired, unknown, ...)

Since:

6.0

getUserMembershipsByRole

List<UserMembership> getUserMembershipsByRole(long roleId,
                                            int startIndex,
                                            int maxResults)

Retrieves the paginated list of user memberships of the role. It retrieves from the startIndex to the startIndex + maxResults.

Parameters:

roleId - the identifier of the role

startIndex - the start index

maxResults - the max number of user memberships

Returns:

the paginated list of user memberships

Throws:

RetrieveException - If an exception occurs during the count retrieving

InvalidSessionException - If the session is invalid (expired, unknown, ...)

Since:

6.0