com.plumtree.server
Interface IPTUserInfo

public interface IPTUserInfo

UserInfo is information about the current user that is sent to portlets. UserInfo can be initialized with user profile information when a user logs in.

Version:

$Revision$

Author:

Mike Jahr

See Also:

IPTSession.GetUserInfo()

Method Summary

void	AddUserInfoSetting(java.lang.String bstrName, double vValue) Adds a userinfo setting.
void	AddUserInfoSetting(java.lang.String bstrName, int vValue) Adds a userinfo setting.
void	AddUserInfoSetting(java.lang.String bstrName, java.lang.String vValue) Adds a userinfo setting.
void	AddUserInfoSetting(java.lang.String bstrName, com.plumtree.openfoundation.util.XPDateTime vValue) Adds a userinfo setting.
java.lang.String	GetAccessingFromIntranet() Returns whether the user is accessing the portal from the Intranet.
java.lang.String	GetDepartment() Returns the user's department.
java.lang.String	GetEmail() Returns the user's email.
java.lang.String	GetEmployeeID() Returns the user's employee id.
java.lang.String	GetFullName() Returns the user's name.
java.lang.String	GetHostPageQueryString() Used to pass the original query string from the host page URL to portlets.
java.lang.String	GetManager() Returns the user's manager.
java.lang.String	GetPhone() Returns the user's phone.
int	GetProfileUserID() Used internally by the intrinsic User Profile Community to specify which user's profile is being viewed.
java.lang.String	GetSetting(java.lang.String name) Returns a single setting by name.
java.lang.String	GetTitle() Returns the user's title.
java.lang.String	GetZipCode() Returns the user's zip code.
java.lang.Object[][]	LookupUserInfoSettings(java.lang.Object vsaUserInfoSettings) Deprecated.
java.lang.Object[][]	LookupUserInfoSettings(java.lang.String vsaUserInfoSettings) Deprecated.
java.lang.Object[][]	LookupUserInfoSettings(java.lang.String[] vsaUserInfoSettings) Returns the specified UserInfo settings.
void	Merge(IPTUserInfo pUserInfo) Adds everything in the incoming IPTUserInfo to the current IPTUserInfo.
void	SetAccessingFromIntranet(java.lang.String Value) Sets whether the user is accessing the portal from the Intranet.
void	SetDepartment(java.lang.String Value) Sets the user's department.
void	SetEmail(java.lang.String Value) Sets the user's email.
void	SetEmployeeID(java.lang.String Value) Sets the user's employee id.
void	SetFullName(java.lang.String Value) Sets the user's name.
void	SetHostPageQueryString(java.lang.String Value) Used to pass the original query string from the host page URL to portlets.
void	SetManager(java.lang.String Value) Sets the user's manager.
void	SetPhone(java.lang.String Value) Sets the user's phone.
void	SetProfileUserID(int Value) Used internally by the intrinsic User Profile Community to specify which user's profile is being viewed.
void	SetTitle(java.lang.String Value) Sets the user's title.
void	SetZipCode(java.lang.String Value) Sets the user's zip code.

Method Detail

GetSetting

java.lang.String GetSetting(java.lang.String name)

Returns a single setting by name.

Parameters:

name - of the settings

Returns:

the value

LookupUserInfoSettings

java.lang.Object[][] LookupUserInfoSettings(java.lang.String[] vsaUserInfoSettings)

Returns the specified UserInfo settings.

Parameters:

vsaUserInfoSettings - array of settings to request

Returns:

array of [name, value]

LookupUserInfoSettings

java.lang.Object[][] LookupUserInfoSettings(java.lang.String vsaUserInfoSettings)

Deprecated.

LookupUserInfoSettings

java.lang.Object[][] LookupUserInfoSettings(java.lang.Object vsaUserInfoSettings)

Deprecated.

AddUserInfoSetting

void AddUserInfoSetting(java.lang.String bstrName,
                        int vValue)

Adds a userinfo setting.

Parameters:

bstrName - setting name

vValue - setting value

AddUserInfoSetting

void AddUserInfoSetting(java.lang.String bstrName,
                        java.lang.String vValue)

Adds a userinfo setting.

Parameters:

bstrName - setting name

vValue - setting value

AddUserInfoSetting

void AddUserInfoSetting(java.lang.String bstrName,
                        com.plumtree.openfoundation.util.XPDateTime vValue)

Adds a userinfo setting.

Parameters:

bstrName - setting name

vValue - setting value

AddUserInfoSetting

void AddUserInfoSetting(java.lang.String bstrName,
                        double vValue)

Adds a userinfo setting.

Parameters:

bstrName - setting name

vValue - setting value

Merge

void Merge(IPTUserInfo pUserInfo)

Adds everything in the incoming IPTUserInfo to the current IPTUserInfo. Values in the new IPTUserInfo will override values in this one.

Parameters:

pUserInfo - IPTUserInfo to merge

SetFullName

void SetFullName(java.lang.String Value)

Sets the user's name.

Parameters:

Value - the user's name

GetFullName

java.lang.String GetFullName()

Returns the user's name.

Returns:

the user's name

SetEmail

void SetEmail(java.lang.String Value)

Sets the user's email.

Parameters:

Value - the user's email

GetEmail

java.lang.String GetEmail()

Returns the user's email.

Returns:

the user's email

SetPhone

void SetPhone(java.lang.String Value)

Sets the user's phone.

Parameters:

Value - the user's phone

GetPhone

java.lang.String GetPhone()

Returns the user's phone.

Returns:

the user's phone

SetEmployeeID

void SetEmployeeID(java.lang.String Value)

Sets the user's employee id.

Parameters:

Value - the user's employee id

GetEmployeeID

java.lang.String GetEmployeeID()

Returns the user's employee id.

Returns:

the user's employee id

SetDepartment

void SetDepartment(java.lang.String Value)

Sets the user's department.

Parameters:

Value - the user's department

GetDepartment

java.lang.String GetDepartment()

Returns the user's department.

Returns:

the user's department

SetTitle

void SetTitle(java.lang.String Value)

Sets the user's title.

Parameters:

Value - the user's title

GetTitle

java.lang.String GetTitle()

Returns the user's title.

Returns:

the user's title

SetZipCode

void SetZipCode(java.lang.String Value)

Sets the user's zip code.

Parameters:

Value - the user's zip code

GetZipCode

java.lang.String GetZipCode()

Returns the user's zip code.

Returns:

the user's zip code

SetManager

void SetManager(java.lang.String Value)

Sets the user's manager.

Parameters:

Value - the user's manager

GetManager

java.lang.String GetManager()

Returns the user's manager.

Returns:

the user's manager

SetAccessingFromIntranet

void SetAccessingFromIntranet(java.lang.String Value)

Sets whether the user is accessing the portal from the Intranet.

Parameters:

Value - whether the user is accessing the portal from the Intranet

GetAccessingFromIntranet

java.lang.String GetAccessingFromIntranet()

Returns whether the user is accessing the portal from the Intranet.

Returns:

whether the user is accessing the portal from the Intranet

SetProfileUserID

void SetProfileUserID(int Value)

Used internally by the intrinsic User Profile Community to specify which user's profile is being viewed.

Parameters:

Value - a user id

GetProfileUserID

int GetProfileUserID()

Used internally by the intrinsic User Profile Community to specify which user's profile is being viewed.

Returns:

a user id

SetHostPageQueryString

void SetHostPageQueryString(java.lang.String Value)

Used to pass the original query string from the host page URL to portlets.

Parameters:

query - string

GetHostPageQueryString

java.lang.String GetHostPageQueryString()

Used to pass the original query string from the host page URL to portlets.

Returns:

query string