com.plumtree.server
Interface IPTProfileManager

All Superinterfaces:

IPTUnknown

public interface IPTProfileManager
extends IPTUnknown

Interface to access information about user profiles.

Version:

$Revision$

Author:

Mike Jahr

Method Summary

void	CleanupProfileCommunity() Cleans up UserInfo information used by profile portlets.
IPTQueryResult	GetManagedCommunities(int nUserID) Returns a list of communities for which the given user has edit access, and the current user has read access.
IPTUserInfo	GetUserInfo(int nUserID) Returns UserInfo for a particular user.
java.lang.Object[][]	GetUserInfoMap() Returns the map from property id to UserInfo attribute.
java.lang.Object	GetUserName(int nUserID) Returns the name and description of a user.
IPTObjectProperties	GetUserProperties(int nUserID, boolean bRequestEdit) Returns dser profile properties for a given user.
void	SetupProfileCommunity(int nUserID) Prepare to pass appropriate information to profile portlets by adding information to UserInfo.
void	SetUserInfoMap(java.lang.Object[][] Value) Sets the map from property id to UserInfo attribute.

Methods inherited from interface com.plumtree.server.IPTUnknown

GetInterfaces

Method Detail

GetUserProperties

IPTObjectProperties GetUserProperties(int nUserID,
                                      boolean bRequestEdit)

Returns dser profile properties for a given user. Respects ACLs on the property objects and user object. If only read permission is desired, passing FALSE for bRequestEdit will bypass the security check on the user. More efficient than accessing the same data via the user manager.

Parameters:

nUserID - user whose properties to return

bRequestEdit - whether the client will try to change the values

Returns:

an IPTObjectProperties

GetUserInfo

IPTUserInfo GetUserInfo(int nUserID)

Returns UserInfo for a particular user.

Parameters:

nUserID - a user id

Returns:

a populated IPTUserInfo object

SetUserInfoMap

void SetUserInfoMap(java.lang.Object[][] Value)

Sets the map from property id to UserInfo attribute.

Parameters:

Value - an array of [propertyid, userinfo attribute]

GetUserInfoMap

java.lang.Object[][] GetUserInfoMap()

Returns the map from property id to UserInfo attribute.

Returns:

an array of [propertyid, userinfo attribute]

GetManagedCommunities

IPTQueryResult GetManagedCommunities(int nUserID)

Returns a list of communities for which the given user has edit access, and the current user has read access.

Parameters:

nUserID - a user id

Returns:

a query result of communities

GetUserName

java.lang.Object GetUserName(int nUserID)

Returns the name and description of a user.

Parameters:

nUserID - a user id

Returns:

an array of [name, description]

SetupProfileCommunity

void SetupProfileCommunity(int nUserID)

Prepare to pass appropriate information to profile portlets by adding information to UserInfo. Should only be called by the intrinsic Profile Community.

Parameters:

nUserID - id of the user whose profile we're visiting

CleanupProfileCommunity

void CleanupProfileCommunity()

Cleans up UserInfo information used by profile portlets. Should only be called by the intrinsic Profile Community.