|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.plumtree.uiinfrastructure.statichelpers.PersonalSettingsHelper
public class PersonalSettingsHelper
Helper to get and set key values on the HTTPSession sandbox. Please refer to AActivitySpace to see usage. Includes things originally in LoginHelper; intent is to support core personal settings applicable to any product: access style, locale, language.
Field Summary | |
---|---|
static java.lang.String |
ACCESS_STYLE
key session setting names used by defaults |
static java.lang.String |
BASE_URL
|
static java.lang.String |
LANGUAGE
|
static java.lang.String |
LOCALE
|
static java.lang.String |
PREFS_SUBSESSION_NAME
name of the personal settings sub-session. |
static java.lang.String |
TIMEZONE
|
Constructor Summary | |
---|---|
PersonalSettingsHelper()
|
Method Summary | |
---|---|
static boolean |
DoesPrefsSubSessionExist(AActivitySpace activitySpace)
Call this method to determine if the subsession for caching personal settings exists in the specified ISessionManager. |
static boolean |
DoesPrefsSubSessionExist(ISessionManager sessionManager)
Use this version of DoesPrefsSubSessionExist if all you have is the session manager. |
static java.lang.Object |
FindPersonalSetting(java.lang.Object[][] oaSettings,
java.lang.String sName)
Call this method to find the value associated with given setting name. |
static java.lang.Object |
GetPersonalSettingValue(java.lang.String sSettingName,
AActivitySpace activitySpace)
Call this method to obtain the value of a personal setting. |
static java.lang.Object |
GetPersonalSettingValue(java.lang.String sSettingName,
ISessionManager sessionManager,
IApplication application)
Only use this version if all you have is the subsession |
static void |
RemovePersonalSetting(java.lang.String sSettingName,
ISessionManager sessionManager)
Call this method to remove a personal setting name on the session (infrastructure HttpSession sandbox) |
static void |
SetPersonalSettingValue(java.lang.String sSettingName,
java.lang.Object oSettingVal,
AActivitySpace activitySpace)
Call this method to set a personal setting name value pair on the session (infrastructure HttpSession sandbox) |
static void |
SetPersonalSettingValue(java.lang.String sSettingName,
java.lang.Object oSettingVal,
ISessionManager sessionManager)
Call this method to set a personal setting name value pair on the session (infrastructure HttpSession sandbox) |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String ACCESS_STYLE
public static final java.lang.String LOCALE
public static final java.lang.String LANGUAGE
public static final java.lang.String TIMEZONE
public static final java.lang.String BASE_URL
public static final java.lang.String PREFS_SUBSESSION_NAME
Constructor Detail |
---|
public PersonalSettingsHelper()
Method Detail |
---|
public static boolean DoesPrefsSubSessionExist(AActivitySpace activitySpace)
AActivitySpace
- public static boolean DoesPrefsSubSessionExist(ISessionManager sessionManager)
ISessionManager
- public static java.lang.Object FindPersonalSetting(java.lang.Object[][] oaSettings, java.lang.String sName)
oaSettings
- Pass an Object[][] obtained from LookupPersonalSettingsString
- name of settingpublic static java.lang.Object GetPersonalSettingValue(java.lang.String sSettingName, ISessionManager sessionManager, IApplication application)
sSettingName
- String name of personal settingsessionManager
- ISessionManager
XPException
- This method will throw an XPException if you do not
pass an ISessionManager already containing the correct subSession. The
ISessionManager obtained from your Activity Space will contain the correct
subsession.public static java.lang.Object GetPersonalSettingValue(java.lang.String sSettingName, AActivitySpace activitySpace)
sSettingName
- String name of personal settingAActivitySpace
- as
XPException
- This method will throw an XPException if you do not
pass an ISessionManager already containing the correct subSession. The
ISessionManager obtained from your Activity Space will contain the correct
subsession.public static void SetPersonalSettingValue(java.lang.String sSettingName, java.lang.Object oSettingVal, AActivitySpace activitySpace)
sSettingName
- String name of personal settingoSettingVal
- Object value of personal settingas
- AActivitySpace Pass an AActivitySpace implementing
IXPActivitySpace.
XPException
- This method may throw an XPException.public static void SetPersonalSettingValue(java.lang.String sSettingName, java.lang.Object oSettingVal, ISessionManager sessionManager)
sSettingName
- String name of personal settingoSettingVal
- Object value of personal settingsessionManager
- ISessionManager Pass the correct subsession (AS.
GetSubSession)
XPException
- This method may throw an XPException.public static void RemovePersonalSetting(java.lang.String sSettingName, ISessionManager sessionManager)
sSettingName
- String name of personal settingsessionManager
- ISessionManager Pass the correct subsession (AS.
GetSubSession)
XPException
- This method may throw an XPException.
|
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |