org.bonitasoft.engine.profile

Interface ProfileService

All Known Implementing Classes:

ProfileServiceImpl

public interface ProfileService

Author:

Matthieu Chaffotte, Elias Ricken de Medeiros, Celine Souchet

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ENTRY_PROFILE
static java.lang.String	PROFILE
static java.lang.String	PROFILE_MEMBER

Method Summary

Modifier and Type	Method and Description
SProfileMember	addGroupToProfile(long profileId, long groupId, java.lang.String groupName, java.lang.String parentPath) Add a group to exist profile
SProfileMember	addRoleAndGroupToProfile(long profileId, long roleId, long groupId, java.lang.String roleName, java.lang.String groupName, java.lang.String groupParentPath) Add a role and a group to exist profile
SProfileMember	addRoleToProfile(long profileId, long roleId, java.lang.String roleName) Add a role to exist profile
SProfileMember	addUserToProfile(long profileId, long userId, java.lang.String firstName, java.lang.String lastName, java.lang.String userName) Add a user to exist profile
SProfile	createProfile(SProfile profile) Add a new profile
SProfileEntry	createProfileEntry(SProfileEntry profileEntry) Add new profile entry
void	deleteAllProfileEntriesOfProfile(SProfile profile)
void	deleteAllProfileMembers() Delete all profile members for the connected tenant
void	deleteAllProfileMembersOfProfile(SProfile profile)
void	deleteProfile(long profileId) Delete profile by its id
void	deleteProfile(SProfile profile) Delete profile by given sProfile
void	deleteProfileEntry(long profileEntryId) Delete a profile entry by its id
void	deleteProfileEntry(SProfileEntry profileEntry) Delete a profileEntry by given profileEntry
void	deleteProfileMember(long profileMemberId) Delete a profile member by its id
void	deleteProfileMember(SProfileMember profileMember) Delete a profile member by given sProfile member
java.util.List<SProfileEntry>	getEntriesOfProfile(java.lang.String profileName)
long	getNumberOfProfileEntries(QueryOptions queryOptions)
long	getNumberOfProfileMembers(java.lang.String querySuffix, QueryOptions countOptions) Get the total number of profile members
long	getNumberOfProfiles(QueryOptions queryOptions)
SProfile	getProfile(long profileId) Get profile by its id
SProfile	getProfileByName(java.lang.String profileName) Get profile by given name
SProfileEntry	getProfileEntry(long profileEntryId) Get profile entry by its id
java.util.List<SProfileMember>	getProfileMembers(java.util.List<java.lang.Long> profileIds) Get the total number of sProfileMember by a list contains profileIds
java.util.List<SProfileMember>	getProfileMembers(long profileId, QueryOptions queryOptions) Get a list of profileMembers by the given profileId
java.util.List<SProfileMember>	getProfileMembersOfGroup(long groupId, int fromIndex, int numberOfElements, java.lang.String field, OrderByType order) Get all sProfileMembers with same group having the given value for the given int index
java.util.List<SProfileMember>	getProfileMembersOfRole(long roleId, int fromIndex, int numberOfElements, java.lang.String field, OrderByType order) Get all sProfileMembers with same group having the given value for the given int index
java.util.List<SProfileMember>	getProfileMembersOfUser(long userId, int fromIndex, int numberOfElements, java.lang.String field, OrderByType order) Get all sProfileMembers with same user having the given value for the given int index
SProfileMember	getProfileMemberWithoutDisplayName(long profileMemberId)
java.util.List<SProfile>	getProfiles(java.util.List<java.lang.Long> profileIds) Get all profiles by given ids
java.util.List<SProfile>	getProfilesOfUser(long userId)
java.util.List<SProfileEntry>	searchProfileEntries(QueryOptions queryOptions)
java.util.List<SProfileMember>	searchProfileMembers(java.lang.String querySuffix, QueryOptions searchOptions) Get all sProfileMember by profileId and queryOptions
java.util.List<SProfile>	searchProfiles(QueryOptions queryOptions)
java.util.List<SProfile>	searchProfilesOfUser(long userId, int fromIndex, int numberOfElements, java.lang.String field, OrderByType order) Get all profiles of the user by userId
java.util.List<SProfile>	searchProfilesWithNavigationOfUser(long userId, int fromIndex, int numberOfElements, java.lang.String field, OrderByType order) Get all profiles with portal navigation for a user
SProfile	updateProfile(SProfile profile, EntityUpdateDescriptor descriptor) Update profile by given profile and new content
SProfileEntry	updateProfileEntry(SProfileEntry profileEntry, EntityUpdateDescriptor descriptor) Update a profileEntry by given profileEntry and new content
void	updateProfileMetaData(long profileId) updates profile metaData fields lastUpdateDate and lastUpdatedBy for a given profile

Field Detail

PROFILE

static final java.lang.String PROFILE

See Also:

Constant Field Values

ENTRY_PROFILE

static final java.lang.String ENTRY_PROFILE

See Also:

Constant Field Values

PROFILE_MEMBER

static final java.lang.String PROFILE_MEMBER

See Also:

Constant Field Values

Method Detail

getProfile

SProfile getProfile(long profileId)
             throws SProfileNotFoundException

Get profile by its id

Parameters:

profileId -

Returns:

sProfile

Throws:

SProfileNotFoundException - occurs when the identifier does not refer to an existing sProfile

Since:

6.0

getProfiles

java.util.List<SProfile> getProfiles(java.util.List<java.lang.Long> profileIds)
                              throws SProfileNotFoundException

Get all profiles by given ids

Parameters:

profileIds - a list contains many profile id

Returns:

Throws:

SProfileNotFoundException - occurs when the identifier does not refer to an existing sProfile

Since:

6.0

createProfile

SProfile createProfile(SProfile profile)
                throws SProfileCreationException

Add a new profile

Parameters:

profile -

Returns:

sProfile

Throws:

SProfileCreationException - occurs when an exception is thrown during sProfile creation

Since:

6.0

updateProfile

SProfile updateProfile(SProfile profile,
                       EntityUpdateDescriptor descriptor)
                throws SProfileUpdateException

Update profile by given profile and new content

Parameters:

profile -

descriptor -

Returns:

The updated profile

Throws:

SProfileUpdateException - occurs when an exception is thrown during sProfile update

Since:

6.0

deleteProfile

void deleteProfile(SProfile profile)
            throws SProfileNotFoundException,
                   SProfileDeletionException,
                   SProfileEntryDeletionException,
                   SProfileMemberDeletionException

Delete profile by given sProfile

Parameters:

profile -

Throws:

SProfileNotFoundException - occurs when the identifier does not refer to an existing sProfile

SProfileDeletionException - occurs when an exception is thrown during sProfile deletion

SProfileEntryDeletionException

SProfileMemberDeletionException

Since:

6.0

deleteProfile

void deleteProfile(long profileId)
            throws SProfileNotFoundException,
                   SProfileDeletionException,
                   SProfileEntryDeletionException,
                   SProfileMemberDeletionException

Delete profile by its id

Parameters:

profileId -

Throws:

SProfileNotFoundException - occurs when the identifier does not refer to an existing sProfile

SProfileDeletionException - occurs when an exception is thrown during sProfile deletion

SProfileEntryDeletionException

SProfileMemberDeletionException

Since:

6.0

searchProfilesOfUser

java.util.List<SProfile> searchProfilesOfUser(long userId,
                                              int fromIndex,
                                              int numberOfElements,
                                              java.lang.String field,
                                              OrderByType order)
                                       throws SBonitaReadException

Get all profiles of the user by userId

Parameters:

userId -

fromIndex - first result to be considered(>=0)

numberOfProfileEntry - the max number of profileEntry to be returned (>=0)

field -

order -

Returns:

A list of sProfile

Throws:

SBonitaReadException

Since:

6.0

getProfilesOfUser

java.util.List<SProfile> getProfilesOfUser(long userId)
                                    throws SBonitaReadException

Throws:

SBonitaReadException

searchProfilesWithNavigationOfUser

java.util.List<SProfile> searchProfilesWithNavigationOfUser(long userId,
                                                            int fromIndex,
                                                            int numberOfElements,
                                                            java.lang.String field,
                                                            OrderByType order)
                                                     throws SBonitaReadException

Get all profiles with portal navigation for a user

Parameters:

userId -

fromIndex - first result to be considered(>=0)

numberOfProfileEntry - the max number of profileEntry to be returned (>=0)

field -

order -

Returns:

A list of sProfile

Throws:

SBonitaReadException

Since:

7.6.1

getProfileEntry

SProfileEntry getProfileEntry(long profileEntryId)
                       throws SProfileEntryNotFoundException

Get profile entry by its id

Parameters:

profileEntryId -

Returns:

sProfileEntry

Throws:

SProfileEntryNotFoundException - occurs when the identifier does not refer to an existing sProfileEntry

Since:

6.0

getEntriesOfProfile

java.util.List<SProfileEntry> getEntriesOfProfile(java.lang.String profileName)
                                           throws SBonitaReadException,
                                                  SProfileNotFoundException

Parameters:

profileName -

Returns:

all profile entries of the profile

Throws:

SBonitaReadException

SProfileNotFoundException

Since:

6.0

createProfileEntry

SProfileEntry createProfileEntry(SProfileEntry profileEntry)
                          throws SProfileEntryCreationException

Add new profile entry

Parameters:

profileEntry -

Returns:

the new created sProfileEntry

Throws:

SProfileEntryCreationException - occurs when an exception is thrown during sProfileEntry creation

Since:

6.0

updateProfileEntry

SProfileEntry updateProfileEntry(SProfileEntry profileEntry,
                                 EntityUpdateDescriptor descriptor)
                          throws SProfileEntryUpdateException

Update a profileEntry by given profileEntry and new content

Parameters:

profileEntry -

descriptor -

Returns:

The updated profile entry

Throws:

SProfileEntryUpdateException - occurs when an exception is thrown during sProfileEntry update

Since:

6.0

deleteProfileEntry

void deleteProfileEntry(SProfileEntry profileEntry)
                 throws SProfileEntryDeletionException

Delete a profileEntry by given profileEntry

Parameters:

profileEntry -

Throws:

SProfileEntryDeletionException - occurs when an exception is thrown during sProfileEntry deletion

Since:

6.0

deleteProfileEntry

void deleteProfileEntry(long profileEntryId)
                 throws SProfileEntryNotFoundException,
                        SProfileEntryDeletionException

Delete a profile entry by its id

Parameters:

profileEntryId -

Throws:

SProfileEntryNotFoundException - occurs when the identifier does not refer to an existing sProfileEntry

SProfileEntryDeletionException - occurs when an exception is thrown during sProfileEntry deletion

Since:

6.0

addUserToProfile

SProfileMember addUserToProfile(long profileId,
                                long userId,
                                java.lang.String firstName,
                                java.lang.String lastName,
                                java.lang.String userName)
                         throws SProfileMemberCreationException

Add a user to exist profile

Parameters:

profileId - the identifier of profile

userId - the identifier of user

firstName -

lastName -

userName -

Returns:

sProfileMember

Throws:

SProfileMemberCreationException

Since:

6.0

addGroupToProfile

SProfileMember addGroupToProfile(long profileId,
                                 long groupId,
                                 java.lang.String groupName,
                                 java.lang.String parentPath)
                          throws SProfileMemberCreationException

Add a group to exist profile

Parameters:

profileId - the identifier of profile

groupId - the identifier of group

groupName -

parentPath -

Returns:

sProfileMember

Throws:

SProfileMemberCreationException - TODO

Since:

6.0

addRoleToProfile

SProfileMember addRoleToProfile(long profileId,
                                long roleId,
                                java.lang.String roleName)
                         throws SProfileMemberCreationException

Add a role to exist profile

Parameters:

profileId - the identifier of profile

roleId - the identifier of role

roleName -

Returns:

sProfileMember

Throws:

SProfileMemberCreationException - TODO

Since:

6.0

addRoleAndGroupToProfile

SProfileMember addRoleAndGroupToProfile(long profileId,
                                        long roleId,
                                        long groupId,
                                        java.lang.String roleName,
                                        java.lang.String groupName,
                                        java.lang.String groupParentPath)
                                 throws SProfileMemberCreationException

Add a role and a group to exist profile

Parameters:

profileId - the identifier of profile

roleId - the identifier of role

groupId - the identifier of group

roleName -

groupName -

groupParentPath -

Returns:

sProfileMember

Throws:

SProfileMemberCreationException - TODO

Since:

6.0

getProfileMembersOfUser

java.util.List<SProfileMember> getProfileMembersOfUser(long userId,
                                                       int fromIndex,
                                                       int numberOfElements,
                                                       java.lang.String field,
                                                       OrderByType order)
                                                throws SBonitaReadException

Get all sProfileMembers with same user having the given value for the given int index

Parameters:

userId - the identifier of user

fromIndex - first result to be considered(>=0)

numberOfProfileEntry - the max number of profileEntry to be returned (>=0)

field -

order -

Returns:

sProfileMember

Throws:

SBonitaReadException - occurs when an exception is thrown during sProfileMember creation

Since:

6.0

getProfileMembersOfGroup

java.util.List<SProfileMember> getProfileMembersOfGroup(long groupId,
                                                        int fromIndex,
                                                        int numberOfElements,
                                                        java.lang.String field,
                                                        OrderByType order)
                                                 throws SBonitaReadException

Get all sProfileMembers with same group having the given value for the given int index

Parameters:

groupId - the identifier of group

fromIndex - first result to be considered(>=0)

numberOfProfileEntry - the max number of profileEntry to be returned (>=0)

field -

order -

Returns:

sProfileMember

Throws:

SBonitaReadException - occurs when an exception is thrown during sProfileMember creation

Since:

6.0

getProfileMembersOfRole

java.util.List<SProfileMember> getProfileMembersOfRole(long roleId,
                                                       int fromIndex,
                                                       int numberOfElements,
                                                       java.lang.String field,
                                                       OrderByType order)
                                                throws SBonitaReadException

Get all sProfileMembers with same group having the given value for the given int index

Parameters:

roleId - the identifier of role

fromIndex - first result to be considered(>=0)

numberOfProfileEntry - the max number of profileEntry to be returned (>=0)

field -

order -

Returns:

sProfileMember

Throws:

SBonitaReadException - occurs when an exception is thrown during sProfileMember creation

Since:

6.0

deleteProfileMember

void deleteProfileMember(long profileMemberId)
                  throws SProfileMemberDeletionException,
                         SProfileMemberNotFoundException

Delete a profile member by its id

Parameters:

profileMemberId -

Throws:

SProfileMemberDeletionException - occurs when an exception is thrown during sProfileMember deletion

SProfileMemberNotFoundException - occurs when the identifier does not refer to an existing sProfileMember

Since:

6.0

deleteProfileMember

void deleteProfileMember(SProfileMember profileMember)
                  throws SProfileMemberDeletionException

Delete a profile member by given sProfile member

Parameters:

profileMember -

Throws:

SProfileMemberDeletionException - occurs when an exception is thrown during sProfileMember deletion

Since:

6.0

getNumberOfProfileMembers

long getNumberOfProfileMembers(java.lang.String querySuffix,
                               QueryOptions countOptions)
                        throws SBonitaReadException

Get the total number of profile members

Parameters:

querySuffix - the suffix of query string

countOptions - The criterion used to search profileMembers

Returns:

the total number of profile members

Throws:

SBonitaReadException

Since:

6.0

searchProfileMembers

java.util.List<SProfileMember> searchProfileMembers(java.lang.String querySuffix,
                                                    QueryOptions searchOptions)
                                             throws SBonitaReadException

Get all sProfileMember by profileId and queryOptions

Parameters:

querySuffix - the suffix of query string

countOptions - The criterion used to search profileMembers

Returns:

all sProfileMember by profileId and queryOptions

Throws:

SBonitaReadException

Since:

6.0

getProfileMembers

java.util.List<SProfileMember> getProfileMembers(java.util.List<java.lang.Long> profileIds)
                                          throws SBonitaReadException

Get the total number of sProfileMember by a list contains profileIds

Parameters:

profileIds -

Returns:

A list of

Throws:

SBonitaReadException

Since:

6.0

getProfileByName

SProfile getProfileByName(java.lang.String profileName)
                   throws SProfileNotFoundException,
                          SBonitaReadException

Get profile by given name

Parameters:

profileName -

Returns:

sProfile

Throws:

SProfileNotFoundException - occurs when the identifier does not refer to an existing sProfile

SBonitaReadException

Since:

6.0

getProfileMembers

java.util.List<SProfileMember> getProfileMembers(long profileId,
                                                 QueryOptions queryOptions)
                                          throws SProfileMemberNotFoundException

Get a list of profileMembers by the given profileId

Parameters:

profileId -

Returns:

a list of profileMembers

Throws:

SProfileMemberNotFoundException

deleteAllProfileMembers

void deleteAllProfileMembers()
                      throws SProfileMemberDeletionException

Delete all profile members for the connected tenant

Throws:

SProfileMemberDeletionException

Since:

6.1

getNumberOfProfiles

long getNumberOfProfiles(QueryOptions queryOptions)
                  throws SBonitaReadException

Parameters:

queryOptions -

Returns:

Throws:

SBonitaReadException

searchProfiles

java.util.List<SProfile> searchProfiles(QueryOptions queryOptions)
                                 throws SBonitaReadException

Parameters:

queryOptions -

Returns:

Throws:

SBonitaReadException

getNumberOfProfileEntries

long getNumberOfProfileEntries(QueryOptions queryOptions)
                        throws SBonitaReadException

Parameters:

queryOptions -

Returns:

Throws:

SBonitaReadException

searchProfileEntries

java.util.List<SProfileEntry> searchProfileEntries(QueryOptions queryOptions)
                                            throws SBonitaReadException

Parameters:

queryOptions -

Returns:

Throws:

SBonitaReadException

deleteAllProfileMembersOfProfile

void deleteAllProfileMembersOfProfile(SProfile profile)
                               throws SProfileMemberDeletionException

Parameters:

profile -

Throws:

SProfileMemberDeletionException

Since:

6.3.1

deleteAllProfileEntriesOfProfile

void deleteAllProfileEntriesOfProfile(SProfile profile)
                               throws SProfileEntryDeletionException

Parameters:

profile -

Throws:

SProfileEntryDeletionException

Since:

6.3.1

getProfileMemberWithoutDisplayName

SProfileMember getProfileMemberWithoutDisplayName(long profileMemberId)
                                           throws SProfileMemberNotFoundException

Parameters:

profileMemberId -

Returns:

Throws:

SProfileMemberNotFoundException

Since:

6.3.1

updateProfileMetaData

void updateProfileMetaData(long profileId)
                    throws SProfileUpdateException

updates profile metaData fields lastUpdateDate and lastUpdatedBy for a given profile

Parameters:

profileId -

Throws:

SProfileUpdateException - when given profileId is not found