com.communote.server.core.user

Interface UserProfileManagement

All Known Implementing Classes:

UserProfileManagementBase, UserProfileManagementImpl

public interface UserProfileManagement

Author:

Communote GmbH - http://www.communote.com/

Method Summary

Modifier and Type	Method and Description
void	addMessagingConnectorConfig(Long notificationConfigId, MessagerConnectorConfig config)
void	anonymizeUserProfile(Long profileId) Makes a user profile anonymous.
UserProfile	findUserProfileByUserId(Long userId) Finds the user profile to a user.
UserProfileDetailListItem	findUserProfileDetailListItemByUserId(Long userId)
UserProfileVO	findUserProfileVOByUserId(Long userId)
List<MessagerConnectorConfigTO>	getMessagerConnectorConfigs() Returns the messager connector configurations of the current user.
UserProfileDetails	getUserProfileDetailsById(Long id) Deprecated. Use getUserProfileDetailsById(Long, boolean) instead.
UserProfileDetails	getUserProfileDetailsById(Long id, boolean needsExternalAuthentications)
boolean	hasCustomUserImage(Long userId) Return whether a user uploaded a custom image.
ImageVO	loadImage(Long userId) Get the user image
boolean	removeUserImage(Long userId) Remove the image of a user.
void	updateImage(Long userId, byte[] largeUserImage) Update the image of a user.
void	updateNotificationConfig(Map<MessagerConnectorType,MessagerConnectorConfigTO> connectorConfigs) Updates the notification configuration of the current user by adding new, removing or updating existing messager connector configurations.
void	updateUserProfile(Long userId, UserProfileVO userProfile) Updates the user profile in the database.

Method Detail

addMessagingConnectorConfig

void addMessagingConnectorConfig(Long notificationConfigId,
                                 MessagerConnectorConfig config)

Parameters:

notificationConfigId - Id of the notification config.

config - The configuration.

anonymizeUserProfile

void anonymizeUserProfile(Long profileId)

Makes a user profile anonymous.

Parameters:

profileId - Id of the profile.

findUserProfileByUserId

UserProfile findUserProfileByUserId(Long userId)

Finds the user profile to a user.

Parameters:

userId - The users id.

Returns:

The profile.

findUserProfileDetailListItemByUserId

UserProfileDetailListItem findUserProfileDetailListItemByUserId(Long userId)

Parameters:

userId - The users id.

Returns:

The Profile.

findUserProfileVOByUserId

UserProfileVO findUserProfileVOByUserId(Long userId)

Parameters:

userId - The users id.

Returns:

The profile.

getUserProfileDetailsById

@Deprecated
UserProfileDetails getUserProfileDetailsById(Long id)

Deprecated. Use getUserProfileDetailsById(Long, boolean) instead.

Parameters:

id - the ID of the user

Returns:

the profile details of the user identified by the provided ID

getUserProfileDetailsById

UserProfileDetails getUserProfileDetailsById(Long id,
                                             boolean needsExternalAuthentications)

Parameters:

id - the ID of the user

needsExternalAuthentications - Set to true, if the external authentications are needed for the user.

Returns:

the profile details of the user identified by the provided ID

getMessagerConnectorConfigs

List<MessagerConnectorConfigTO> getMessagerConnectorConfigs()

Returns the messager connector configurations of the current user.

Returns:

the messager connector configurations of the current user

hasCustomUserImage

boolean hasCustomUserImage(Long userId)

Return whether a user uploaded a custom image.

Parameters:

userId - the ID of the user

Returns:

true if the user exists and has a custom image, false otherwise

loadImage

ImageVO loadImage(Long userId)

Get the user image

Parameters:

userId - The users id.

Returns:

The image.

removeUserImage

boolean removeUserImage(Long userId)
                 throws AuthorizationException,
                        UserNotFoundException

Remove the image of a user.

Parameters:

userId - The ID of the user whose image should be removed

Returns:

true if the image was removed or false if the user did not have a custom image

Throws:

AuthorizationException - in case the current user is not the user whose image should be updated or the current user is not client manager or internal system user

UserNotFoundException - in case the user with ID userId does not exist

updateImage

void updateImage(Long userId,
                 byte[] largeUserImage)
          throws AuthorizationException,
                 UserNotFoundException

Update the image of a user.

Parameters:

userId - The users id.

largeUserImage - The user image as byte array.

Throws:

AuthorizationException - in case the current user is not the user whose image should be updated or the current user is not client manager or internal system user

UserNotFoundException - in case the user with ID userId does not exist

updateNotificationConfig

void updateNotificationConfig(Map<MessagerConnectorType,MessagerConnectorConfigTO> connectorConfigs)

Updates the notification configuration of the current user by adding new, removing or updating existing messager connector configurations.

Parameters:

connectorConfigs - a definition with the new connector configurations. Configurations for connector types that are not yet part of the notification configuration of the current user will be added. Configurations with connector types that are part of the current notification configuration but that are not listed in the mapping will be removed. All the the other configurations will be updated if necessary.

updateUserProfile

void updateUserProfile(Long userId,
                       UserProfileVO userProfile)

Updates the user profile in the database.

Parameters:

userId - The users id.

userProfile - The profile.