public
class
WebLinkConfigurationCache
extends Object| java.lang.Object | |
| ↳ | com.microstrategy.web.objects.WebLinkConfigurationCache |
Summary
| Constants | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| String | PROPERTY_LOCALE_DATE_NUMBER | ||||||||||
| String | PROPERTY_LOCALE_INTERFACE | ||||||||||
| String | PROPERTY_LOCALE_MD | ||||||||||
| String | PROPERTY_LOCALE_MESSAGES | ||||||||||
| String | PROPERTY_LOCALE_WHD | ||||||||||
| String | PROPERTY_SET_WEB_PREFERENCES | ||||||||||
| String | PROPERTY_WEB_PREFERENCE_VALUES | ||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| WebPropertyGroup |
getConfigurationProperties(WebIServerSession session)
Returns the properties of the configuration object
| ||||||||||
| static WebLinkConfigurationCache |
getInstance()
returns a singleton object representing this cache
NOTE: This cache instance should not be used by any classes other than
the ones defined in the com.microstrategy.web.app or com.microstrategy.web.app.utils package
An UnsupportedOperationException will be thrown for all other clients
There is no guarantee for the support of this class and this might be deprecated in the future
| ||||||||||
| WebLinkItem | getProjectItem(WebIServerSession session, String projectName) | ||||||||||
| WebLinkItem |
getProjectItem(WebIServerSession session)
Returns a
WebLinkItem for the specific project that this session correspons to | ||||||||||
| String[] |
getStopWords(WebIServerSession iServerSession)
Returns Quick Search stop words
| ||||||||||
| WebLinkItem |
getUserItem(WebIServerSession session)
Returns a
WebLinkItem for the specific user that this session correspons to | ||||||||||
| WebLinkItem |
getUserProjectItem(WebIServerSession session, String projectName)
Returns a
WebLinkItem for the specific user and explicitly specified project | ||||||||||
| WebLinkItem |
getUserProjectItem(WebIServerSession session)
Returns a
WebLinkItem for the specific user and project that this session corresponds to | ||||||||||
| WebObjectInfo | loadStopWords(WebIServerSession iServerSession) | ||||||||||
| Protected Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| WebObjectInfo | loadConfigurationObject(WebIServerSession iServerSession) | ||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
| |||||||||||
Constants
public static final String PROPERTY_LOCALE_DATE_NUMBER
Constant Value:
"LocaleForDateNumber"
public static final String PROPERTY_LOCALE_INTERFACE
Constant Value:
"LocaleForInterface"
public static final String PROPERTY_LOCALE_MD
Constant Value:
"LocaleForMD"
public static final String PROPERTY_LOCALE_MESSAGES
Constant Value:
"LocaleForMessage"
public static final String PROPERTY_LOCALE_WHD
Constant Value:
"LocaleForData"
public static final String PROPERTY_SET_WEB_PREFERENCES
Constant Value:
"WebPreferences"
public static final String PROPERTY_WEB_PREFERENCE_VALUES
Constant Value:
"PreferenceValues"
Public Methods
public WebPropertyGroup getConfigurationProperties (WebIServerSession session)
Returns the properties of the configuration object
Parameters
| session | The WebIServerSession for which the configuration object is to be read |
|---|
Returns
- the
WebPropertyGroup
Throws
| WebObjectsException |
|---|
public static WebLinkConfigurationCache getInstance ()
returns a singleton object representing this cache NOTE: This cache instance should not be used by any classes other than the ones defined in the com.microstrategy.web.app or com.microstrategy.web.app.utils package An UnsupportedOperationException will be thrown for all other clients There is no guarantee for the support of this class and this might be deprecated in the future
Returns
- singleton instance of this object
public WebLinkItem getProjectItem (WebIServerSession session, String projectName)
Throws
| WebObjectsException |
|---|
public WebLinkItem getProjectItem (WebIServerSession session)
Returns a WebLinkItem for the specific project that this session correspons to
Returns
- a
WebLinkItemfor the specific project that this session correspons to
Throws
| WebObjectsException |
|---|
public String[] getStopWords (WebIServerSession iServerSession)
Returns Quick Search stop words
Parameters
| iServerSession | a session for which stop words shall be returned |
|---|
Returns
- Quick Search stop words
Throws
| CacheException |
|---|
public WebLinkItem getUserItem (WebIServerSession session)
Returns a WebLinkItem for the specific user that this session correspons to
Returns
- a
WebLinkItemfor the specific user that this session correspons to
Throws
| WebObjectsException |
|---|
public WebLinkItem getUserProjectItem (WebIServerSession session, String projectName)
Returns a WebLinkItem for the specific user and explicitly specified project
Returns
- a
WebLinkItemfor the specific user and project
Throws
| WebObjectsException | |
| WebObjectsException |
public WebLinkItem getUserProjectItem (WebIServerSession session)
Returns a WebLinkItem for the specific user and project that this session corresponds to
Returns
- a
WebLinkItemfor the specific user and project that this session corresponds to
Throws
| WebObjectsException |
|---|
Protected Methods
protected WebObjectInfo loadConfigurationObject (WebIServerSession iServerSession)
Throws
| CacheException |
|---|