org.exoplatform.services.organization

Interface UserProfileHandler

public interface UserProfileHandler

Created by The eXo Platform SAS
This interface is a sub part of the organization service. It is used to manage the UserProfile records, the extra information of an user such address, phone... The interface should allow the developer create , delete and update a UserProfile. and broadcast the event to the user profile event listeners.

Author:

Tuan Nguyen

Level API:

Platform

Method Summary

Methods

Modifier and Type	Method and Description
void	addUserProfileEventListener(UserProfileEventListener listener) When a method save , remove are called , the will broadcast an event.
UserProfile	createUserProfileInstance()
UserProfile	createUserProfileInstance(String userName)
UserProfile	findUserProfileByName(String userName) This method should search for and return UserProfile record according to the username
Collection	findUserProfiles() Find and return all the UserProfile record in the database
UserProfile	removeUserProfile(String userName, boolean broadcast) This method should remove the user profile record in the database.
void	removeUserProfileEventListener(UserProfileEventListener listener) This method is used to unregister listener.
void	saveUserProfile(UserProfile profile, boolean broadcast) This method should persist the profile instance to the database.

Method Detail

createUserProfileInstance

UserProfile createUserProfileInstance()

Returns:

return a new UserProfile implementation instance. This instance is not persisted yet

createUserProfileInstance

UserProfile createUserProfileInstance(String userName)

Parameters:

userName - The user profile record with the username

Returns:

return a new UserProfile implementation instance. This instance is not persisted yet

saveUserProfile

void saveUserProfile(UserProfile profile,
                   boolean broadcast)
                     throws Exception

This method should persist the profile instance to the database. If the profile is not existed yet. the method should create a new user profile record. If there is an existed record. The method should merge the data with the existed record

Parameters:

profile - the profile instance to persist.

broadcast - broadcast the event to the listener if broadcast is true

Throws:

Exception - throw exception if the method fail to access the database or any listener fail to handle the event.

removeUserProfile

UserProfile removeUserProfile(String userName,
                            boolean broadcast)
                              throws Exception

This method should remove the user profile record in the database. If any listener fail to handle event. The record should not be removed from the database.

Parameters:

userName - The user profile record with the username should be removed from the database

broadcast - Broadcast the event the listeners if broadcast is true.

Returns:

The UserProfile instance that has been removed.

Throws:

Exception - Throw exception if the method fail to remove the record or any listener fail to handle the event

findUserProfileByName

UserProfile findUserProfileByName(String userName)
                                  throws Exception

This method should search for and return UserProfile record according to the username

Parameters:

userName - the user name

Returns:

return null if no record match the userName. return an UserProfile instance if a record match the username.

Throws:

Exception - Throw Exception if the method fail to access the database or find more than one record that match the username.

See Also:

UserProfile

findUserProfiles

Collection findUserProfiles()
                            throws Exception

Find and return all the UserProfile record in the database

Returns:

Returns a collection containing all the existing UserProfiles

Throws:

Exception - Throw exception if the method fail to access the database

addUserProfileEventListener

void addUserProfileEventListener(UserProfileEventListener listener)

When a method save , remove are called , the will broadcast an event. You can use this method to register a listener to catch those events

Parameters:

listener - The listener instance

See Also:

UserProfileEventListener

removeUserProfileEventListener

void removeUserProfileEventListener(UserProfileEventListener listener)

This method is used to unregister listener.

Parameters:

listener - The listener instance

See Also:

UserProfileEventListener