Plumtree Portal UI  
 

PTPersonalSettingsHelper Members

PTPersonalSettingsHelper overview

Public Static Fields

ACCESS_STYLE_COOKIE_NAME Access Style Cookie name
LOCALE_USE_BROWSER_SETTING Use Browser Setting ID (Locale)
LOCALE_USE_DEFAULT_SETTING Use Default Setting ID (Locale)

Public Static Methods

CachePersonalSettingsOverloaded. Call this method to cache all personal settings on the session.

This method will also set the session language on the Plumtree server.

DoesPrefsSubSessionExist Call this method to determine if the subsession for caching personal settings exists in the specified ISessionManager.

FindPersonalSetting Call this method to find the value associated with given setting name.

GetDefaultLocale This helper method determines the fall back default locale, assuming that the locale could not be determined by the browser settings. This method will not return UseBrowser as a locale.
GetPersonalDateTimeFormat This method returns an XPDateFormat in the user's current locale and timezone. It's basically a wrapper around GetPersonalSettingValue_Locale and GetPersonalSettingValue_TimeZone.
GetPersonalSettingValueOverloaded. Call this method to obtain the value of a personal setting.

This value will be retrieved from the user's web session if possible, otherwise the portal server will be queried.

GetPersonalSettingValue_Locale This method returns an XPLocale object created from the current user's locale. If that cannot be done, then it returns an XPLocale made from the default locale.
GetPersonalSettingValue_TimeZone This method returns an XPTimeZone object created from the current user's time zone. If that cannot be done, then it returns an XPTimeZone made from the default time zone.
GetPTSession Method GetPTSession. Gets IPTSession from AActivitySpace cleanly.
GetSettingsToCache Retrieve the individual settings to cache in the lower-level HTTPSession as opposed to the higher-level IPTSessionInfo. Defined in x_config.xml
IsLocaleSupported This method determines whether or not the supplied locale matches one of the languages that this server can actually display.
RemovePersonalSetting Call this method to find the remove the specified setting from the DB

SetAndCachePersonalSettingOverloaded. Call this method to set a personal setting name value pair on the portal server, and update the session cache of personal settings.

SetPersonalSetting This method stores a personal setting on the HTTP Session, but not in the DB. It also handles setting the runtime settings in the server for language and locale if you try to set the locale. You should always set the Locale, which will automatically set the language, rather than just setting the language, which will allow the language and locale to get out of sync.

Public Instance Constructors

PTPersonalSettingsHelper Constructor Initializes a new instance of the PTPersonalSettingsHelper class.

Public Instance Methods

Equals (inherited from Object)Determines whether the specified Object is equal to the current Object.
GetHashCode (inherited from Object)Serves as a hash function for a particular type. GetHashCode is suitable for use in hashing algorithms and data structures like a hash table.
GetType (inherited from Object)Gets the Type of the current instance.
ToString (inherited from Object)Returns a String that represents the current Object.

Protected Instance Methods

Finalize (inherited from Object)Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
MemberwiseClone (inherited from Object)Creates a shallow copy of the current Object.

See Also

PTPersonalSettingsHelper Class | com.plumtree.portaluiinfrastructure.login Namespace