org.bonitasoft.engine.api

Interface ProfileAPI

public interface ProfileAPI

Profiles are a notion used in Bonita Portal to give and control access to some specific features of the Bonita suite. Profiles are associated to Bonita Identity / Organization notions: users, groups, roles, memberships. ProfileAPI gives access to some of the profile administration: adding / removing members to / from a profile, retrieving / searching for profiles.
Full control on profiles is part of Subscription editions of Bonita suite.

Author:

Celine Souchet, Matthieu Chaffotte

See Also:

SearchResult for general knowledege on Search mechanism in Bonita.

Method Summary

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) Deprecated. since 6.3
List<Profile>	getProfilesForUser(long userId, int startIndex, int maxResults, ProfileCriterion criterion) Retrieves the profiles of the user.
List<Profile>	getProfilesWithNavigationForUser(long userId, int startIndex, int maxResults, ProfileCriterion criterion) Retrieves the profiles with portal navigation for the user.
SearchResult<ProfileEntry>	searchProfileEntries(SearchOptions options) Searches for ProfileEntrys with specific search criteria.
SearchResult<ProfileMember>	searchProfileMembers(String memberType, SearchOptions options) Searches for ProfileMembers with specific search criteria.
SearchResult<Profile>	searchProfiles(SearchOptions options) Searches for Profiles with specific search criteria.

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

@Deprecated
List<Profile> getProfilesForUser(long userId)
                                      throws UserNotFoundException

Deprecated. since 6.3

Retrieves the profiles of the user.

Parameters:

userId - The identifier of the user

Returns:

The 1000 first profiles of the user, ordered by name

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

See Also:

getProfilesForUser(long, int, int, ProfileCriterion)

getProfilesForUser

List<Profile> getProfilesForUser(long userId,
                                 int startIndex,
                                 int maxResults,
                                 ProfileCriterion criterion)

Retrieves the profiles of the user.

Parameters:

userId - The identifier of the user

startIndex - The index of the first result (starting from 0).

maxResults - The maximum number of elements to get per page.

criterion - The criterion for sorting the items over pages.

Returns:

The paginated and ordered profiles of the user

Throws:

RetrieveException - If an exception occurs during the profile retrieving

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

Since:

6.3.2

getProfilesWithNavigationForUser

List<Profile> getProfilesWithNavigationForUser(long userId,
                                               int startIndex,
                                               int maxResults,
                                               ProfileCriterion criterion)

Retrieves the profiles with portal navigation for the user.

Parameters:

userId - The identifier of the user

startIndex - The index of the first result (starting from 0).

maxResults - The maximum number of elements to get per page.

criterion - The criterion for sorting the items over pages.

Returns:

The paginated and ordered profiles of the user

Throws:

RetrieveException - If an exception occurs during the profile retrieving

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

Since:

7.6.1

searchProfiles

SearchResult<Profile> searchProfiles(SearchOptions options)
                              throws SearchException

Searches for Profiles with specific search criteria. Use ProfileSearchDescriptor to know the available filters.

Parameters:

options - The search criteria

Returns:

a SearchResult containing the list of Profiles matching the search criteria.

Throws:

SearchException - If an exception occurs during the profile searching

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

Since:

6.0

See Also:

Profile, ProfileSearchDescriptor, SearchResult

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 exist, 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 for ProfileMembers with specific search criteria. Use ProfileMemberSearchDescriptor to know the available filters.

Parameters:

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

options - The search criteria

Returns:

a SearchResult containing the list of ProfileMembers matching the search criteria.

Throws:

SearchException - If an exception occurs during the profile searching

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

Since:

6.0

See Also:

ProfileMember, ProfileMemberSearchDescriptor, SearchResult

searchProfileEntries

SearchResult<ProfileEntry> searchProfileEntries(SearchOptions options)
                                         throws SearchException

Searches for ProfileEntrys with specific search criteria. Use ProfileEntrySearchDescriptor to know the available filters.

Parameters:

options - The search criteria.

Returns:

a SearchResult containing the list of ProfileEntrys matching the search criteria.

Throws:

SearchException - If an exception occurs during the profile searching

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

Since:

6.0

See Also:

ProfileEntry, ProfileEntrySearchDescriptor, SearchResult

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