org.bonitasoft.engine.api

Interface ProfileAPI

public interface ProfileAPI

Author:

Celine Souchet, Matthieu Chaffotte

Method Summary

Methods

Modifier and Type	Method and Description
ProfileMember	createProfileMember(Long profileId, Long userId, Long groupId, Long roleId) Creates a profile member.
ProfileMember	createProfileMember(ProfileMemberCreator creator) Creates a profile member.
void	deleteProfileMember(Long id) Deletes the profile member.
Map<Long,Long>	getNumberOfProfileMembers(List<Long> profileIds) Retrieves the number of profile members for the profiles.
Profile	getProfile(long id) Retrieves the profile.
ProfileEntry	getProfileEntry(long id) Retrieves the profile entry.
List<Profile>	getProfilesForUser(long userId) Retrieves the profiles of the user.
SearchResult<ProfileEntry>	searchProfileEntries(SearchOptions options) Searches profile entries according to the criteria containing in the options.
SearchResult<ProfileMember>	searchProfileMembers(String memberType, SearchOptions options) Searches profile members according to the criteria containing in the options.
SearchResult<Profile>	searchProfiles(SearchOptions options) Searches profiles according to the criteria containing in the options.

Method Detail

getProfile

Profile getProfile(long id)
                   throws ProfileNotFoundException

Retrieves the profile.

Parameters:

id - the identifier of the profile

Returns:

the searched profile

Throws:

ProfileNotFoundException - If the identifier does not refer to an existing profile

RetrieveException - If an exception occurs during the profile retrieving

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

Since:

6.0

getProfilesForUser

List<Profile> getProfilesForUser(long userId)
                                 throws UserNotFoundException

Retrieves the profiles of the user.

Parameters:

userId - the identifier of the user

Returns:

the profiles of the user

Throws:

UserNotFoundException - If the user identifier does not refer to an existing user

RetrieveException - If an exception occurs during the profile retrieving

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

Since:

6.0

searchProfiles

SearchResult<Profile> searchProfiles(SearchOptions options)
                                     throws SearchException

Searches profiles according to the criteria containing in the options.

Parameters:

options - the search criteria

Returns:

the search result

Throws:

SearchException - If an exception occurs during the profile searching

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

Since:

6.0

getNumberOfProfileMembers

Map<Long,Long> getNumberOfProfileMembers(List<Long> profileIds)

Retrieves the number of profile members for the profiles. The map contains the couples profileId/numberOfProfileMembers. If a profile does not exists, no exception is thrown and no value is added in the map.

Parameters:

profileIds - the identifiers of the profiles

Returns:

the number of profile members for the profiles

Throws:

RetrieveException - If an exception occurs during the profile retrieving

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

Since:

6.0

searchProfileMembers

SearchResult<ProfileMember> searchProfileMembers(String memberType,
                                               SearchOptions options)
                                                 throws SearchException

Searches profile members according to the criteria containing in the options.

Parameters:

memberType - the member type, it can be: user, role, group, roleAndGroup.

options - the search criteria

Returns:

the search result

Throws:

SearchException - If an exception occurs during the profile searching

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

Since:

6.0

searchProfileEntries

SearchResult<ProfileEntry> searchProfileEntries(SearchOptions options)
                                                throws SearchException

Searches profile entries according to the criteria containing in the options.

Parameters:

options - the search criteria

Returns:

the search result

Throws:

SearchException - If an exception occurs during the profile searching

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

Since:

6.0

getProfileEntry

ProfileEntry getProfileEntry(long id)
                             throws ProfileEntryNotFoundException

Retrieves the profile entry.

Parameters:

id - the identifier of the profile entry

Returns:

the searched profile entry

Throws:

ProfileEntryNotFoundException - If the profile entry identifier does not refer to an existing user

RetrieveException - If an exception occurs during the user retrieving

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

Since:

6.0

createProfileMember

ProfileMember createProfileMember(Long profileId,
                                Long userId,
                                Long groupId,
                                Long roleId)
                                  throws CreationException,
                                         AlreadyExistsException

Creates a profile member.

Parameters:

profileId - the identifier of the profile

userId - the identifier of the user

groupId - the identifier of the group

roleId - the identifier of the role

Returns:

the created profile member

Throws:

AlreadyExistsException - If the tuple profileId/userId/roleId/groupId is already taken by an existing profile member

CreationException - If an exception occurs during the profile member creation

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

Since:

6.0

createProfileMember

ProfileMember createProfileMember(ProfileMemberCreator creator)
                                  throws CreationException,
                                         AlreadyExistsException

Creates a profile member. It takes the values of the creator in order to create the profile member.

Parameters:

creator - the profile member to create

Returns:

the created profile member

Throws:

AlreadyExistsException - If the tuple profileId/userId/roleId/groupId is already taken by an existing profile member

CreationException - If an exception occurs during the profile member creation

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

Since:

6.0

deleteProfileMember

void deleteProfileMember(Long id)
                         throws DeletionException

Deletes the profile member.

Parameters:

id - the identifier of the profile member

Throws:

DeletionException - If an exception occurs during the profile member deletion

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

Since:

6.0