Clearspace API (1.7.0) Core Javadocs

com.jivesoftware.community
Interface ProfileManager

All Superinterfaces:
JiveManager

public interface ProfileManager
extends JiveManager

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


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<java.lang.Long,com.jivesoftware.community.UserProfile> getProfile(User user)
          Gets a map of user profile values for a particular user mapped to their corresponding ProfileField id.
 java.io.InputStream getProfileImage(User user)
           
 void setProfile(User user, java.util.List<com.jivesoftware.community.UserProfile> profile)
          Sets a list of profile values for a particular user.
 void setProfileImage(User user, java.lang.String mimeType, java.io.InputStream in)
           
 
Methods inherited from interface com.jivesoftware.community.JiveManager
destroy, initialize
 

Method Detail

getProfile

java.util.Map<java.lang.Long,com.jivesoftware.community.UserProfile> 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<com.jivesoftware.community.UserProfile> 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.

setProfileImage

void setProfileImage(User user,
                     java.lang.String mimeType,
                     java.io.InputStream in)
                     throws AttachmentException
Throws:
AttachmentException

getProfileImage

java.io.InputStream getProfileImage(User user)

Clearspace Project Page

Copyright © 1999-2007 Jive Software.