Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.profiles
Interface ProfileManager

All Superinterfaces:
UserListener
All Known Implementing Classes:
ProfileManagerImpl

public interface ProfileManager
extends UserListener

Manages user profile and user skill data. Defines methods used to create, access, update, and remove user profile.


Method Summary
 void deleteProfileByID(long fieldID)
          Removes all user profile data associated with a particular profile field.
 void deleteProfileByUserID(long userID)
          Removes all user profile data associated with a particular user.
 java.util.Map getProfile(User user)
          Gets a map of user profile values for a particular user mapped to their corresponding ProfileField id.
 void setProfile(User user, java.util.List profile)
          Sets a list of profile values for a particular user.
 
Methods inherited from interface com.jivesoftware.base.event.UserListener
userCreated, userDeleted, userModified
 

Method Detail

getProfile

java.util.Map getProfile(User user)
Gets a map of user profile values for a particular user mapped to their corresponding ProfileField id.

Parameters:
user - get the profile for this user
Returns:
a map of user profile values for the specified user.

setProfile

void setProfile(User user,
                java.util.List profile)
Sets a list of profile values for a particular user.

Parameters:
user - the user that represents the profile list
profile - the list of user profile values to save

deleteProfileByUserID

void deleteProfileByUserID(long userID)
Removes all user profile data associated with a particular user. This method is generally called when a user is removed from the system.

Parameters:
userID - remove all user profile data associated with this userID.

deleteProfileByID

void deleteProfileByID(long fieldID)
Removes all user profile data associated with a particular profile field. This method is generally called when a profile field is removed from the system.

Parameters:
fieldID - remove all user profile data associated with this profile field id.

Jive Forums Project Page

Copyright © 1999-2006 Jive Software.