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.

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 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 GetTitle()
          Returns the user's title.
 java.lang.String GetZipCode()
          Returns the user's zip code.
 java.lang.Object[][] LookupUserInfoSettings(java.lang.Object vsaUserInfoSettings)
          Returns the specified UserInfo setting.
 java.lang.Object[][] LookupUserInfoSettings(java.lang.String vsaUserInfoSettings)
          Returns the specified UserInfo setting.
 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 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

LookupUserInfoSettings

public 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

public java.lang.Object[][] LookupUserInfoSettings(java.lang.String vsaUserInfoSettings)
Returns the specified UserInfo setting.
Parameters:
vsaUserInfoSettings - setting to request, or null to return all settings.
Returns:
array of [name, value]

LookupUserInfoSettings

public java.lang.Object[][] LookupUserInfoSettings(java.lang.Object vsaUserInfoSettings)
Returns the specified UserInfo setting.
Parameters:
vsaUserInfoSettings - setting to request, or null to return all settings.
Returns:
array of [name, value]

AddUserInfoSetting

public void AddUserInfoSetting(java.lang.String bstrName,
                               int vValue)
Adds a userinfo setting.
Parameters:
bstrName - setting name
vValue - setting value

AddUserInfoSetting

public void AddUserInfoSetting(java.lang.String bstrName,
                               java.lang.String vValue)
Adds a userinfo setting.
Parameters:
bstrName - setting name
vValue - setting value

AddUserInfoSetting

public void AddUserInfoSetting(java.lang.String bstrName,
                               com.plumtree.openfoundation.util.XPDateTime vValue)
Adds a userinfo setting.
Parameters:
bstrName - setting name
vValue - setting value

AddUserInfoSetting

public void AddUserInfoSetting(java.lang.String bstrName,
                               double vValue)
Adds a userinfo setting.
Parameters:
bstrName - setting name
vValue - setting value

Merge

public 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

public void SetFullName(java.lang.String Value)
Sets the user's name.
Parameters:
Value - the user's name

GetFullName

public java.lang.String GetFullName()
Returns the user's name.
Returns:
the user's name

SetEmail

public void SetEmail(java.lang.String Value)
Sets the user's email.
Parameters:
Value - the user's email

GetEmail

public java.lang.String GetEmail()
Returns the user's email.
Returns:
the user's email

SetPhone

public void SetPhone(java.lang.String Value)
Sets the user's phone.
Parameters:
Value - the user's phone

GetPhone

public java.lang.String GetPhone()
Returns the user's phone.
Returns:
the user's phone

SetEmployeeID

public void SetEmployeeID(java.lang.String Value)
Sets the user's employee id.
Parameters:
Value - the user's employee id

GetEmployeeID

public java.lang.String GetEmployeeID()
Returns the user's employee id.
Returns:
the user's employee id

SetDepartment

public void SetDepartment(java.lang.String Value)
Sets the user's department.
Parameters:
Value - the user's department

GetDepartment

public java.lang.String GetDepartment()
Returns the user's department.
Returns:
the user's department

SetTitle

public void SetTitle(java.lang.String Value)
Sets the user's title.
Parameters:
Value - the user's title

GetTitle

public java.lang.String GetTitle()
Returns the user's title.
Returns:
the user's title

SetZipCode

public void SetZipCode(java.lang.String Value)
Sets the user's zip code.
Parameters:
Value - the user's zip code

GetZipCode

public java.lang.String GetZipCode()
Returns the user's zip code.
Returns:
the user's zip code

SetManager

public void SetManager(java.lang.String Value)
Sets the user's manager.
Parameters:
Value - the user's manager

GetManager

public java.lang.String GetManager()
Returns the user's manager.
Returns:
the user's manager

SetAccessingFromIntranet

public 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

public 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

public 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

public int GetProfileUserID()
Used internally by the intrinsic User Profile Community to specify which user's profile is being viewed.
Returns:
a user id


Copyright © 2003 Plumtree Software Inc. All Rights Reserved.