Package com.microstrategy.web.objects

Class WebLinkConfigurationCache

java.lang.Object

com.microstrategy.web.objects.WebLinkConfigurationCache

public class WebLinkConfigurationCache
extends java.lang.Object

Since:

MicroStrategy Web 7.3.1 or earlier

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	PROPERTY_LOCALE_DATE_NUMBER
static java.lang.String	PROPERTY_LOCALE_INTERFACE
static java.lang.String	PROPERTY_LOCALE_MD
static java.lang.String	PROPERTY_LOCALE_MESSAGES
static java.lang.String	PROPERTY_LOCALE_WHD
static java.lang.String	PROPERTY_SET_WEB_PREFERENCES
static java.lang.String	PROPERTY_WEB_PREFERENCE_VALUES

Method Summary

Modifier and Type	Method	Description
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)	Returns a WebLinkItem for the specific project that this session correspons to
WebLinkItem	getProjectItem(WebIServerSession session, java.lang.String projectName)
java.lang.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)	Returns a WebLinkItem for the specific user and project that this session corresponds to
WebLinkItem	getUserProjectItem(WebIServerSession session, java.lang.String projectName)	Returns a WebLinkItem for the specific user and explicitly specified project
protected WebObjectInfo	loadConfigurationObject(WebIServerSession iServerSession)
WebObjectInfo	loadStopWords(WebIServerSession iServerSession)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PROPERTY_SET_WEB_PREFERENCES

public static final java.lang.String PROPERTY_SET_WEB_PREFERENCES

See Also:

Constant Field Values

PROPERTY_WEB_PREFERENCE_VALUES

public static final java.lang.String PROPERTY_WEB_PREFERENCE_VALUES

See Also:

Constant Field Values

PROPERTY_LOCALE_MD

public static final java.lang.String PROPERTY_LOCALE_MD

Since:

MicroStrategy Web 9.0.0

See Also:

Constant Field Values

PROPERTY_LOCALE_WHD

public static final java.lang.String PROPERTY_LOCALE_WHD

Since:

MicroStrategy Web 9.0.0

See Also:

Constant Field Values

PROPERTY_LOCALE_MESSAGES

public static final java.lang.String PROPERTY_LOCALE_MESSAGES

Since:

MicroStrategy Web 9.0.0

See Also:

Constant Field Values

PROPERTY_LOCALE_DATE_NUMBER

public static final java.lang.String PROPERTY_LOCALE_DATE_NUMBER

Since:

MicroStrategy Web 9.0.0

See Also:

Constant Field Values

PROPERTY_LOCALE_INTERFACE

public static final java.lang.String PROPERTY_LOCALE_INTERFACE

Since:

MicroStrategy Web 9.0.0

See Also:

Constant Field Values

Method Detail

getInstance

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

getConfigurationProperties

public WebPropertyGroup getConfigurationProperties(WebIServerSession session)
                                            throws WebObjectsException

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

loadStopWords

public WebObjectInfo loadStopWords(WebIServerSession iServerSession)
                            throws CacheException

Throws:

CacheException

getStopWords

public java.lang.String[] getStopWords(WebIServerSession iServerSession)
                                throws CacheException

Returns Quick Search stop words

Parameters:

iServerSession - a session for which stop words shall be returned

Returns:

Quick Search stop words

Throws:

CacheException

loadConfigurationObject

protected WebObjectInfo loadConfigurationObject(WebIServerSession iServerSession)
                                         throws CacheException

Throws:

CacheException

getUserItem

public WebLinkItem getUserItem(WebIServerSession session)
                        throws WebObjectsException

Returns a WebLinkItem for the specific user that this session correspons to

Parameters:

session -

Returns:

a WebLinkItem for the specific user that this session correspons to

Throws:

WebObjectsException

getProjectItem

public WebLinkItem getProjectItem(WebIServerSession session)
                           throws WebObjectsException

Returns a WebLinkItem for the specific project that this session correspons to

Parameters:

session -

Returns:

a WebLinkItem for the specific project that this session correspons to

Throws:

WebObjectsException

getProjectItem

public WebLinkItem getProjectItem(WebIServerSession session,
                                  java.lang.String projectName)
                           throws WebObjectsException

Throws:

WebObjectsException

Since:

MicroStrategy Web 8.0.0

getUserProjectItem

public WebLinkItem getUserProjectItem(WebIServerSession session)
                               throws WebObjectsException

Returns a WebLinkItem for the specific user and project that this session corresponds to

Parameters:

session -

Returns:

a WebLinkItem for the specific user and project that this session corresponds to

Throws:

WebObjectsException

getUserProjectItem

public WebLinkItem getUserProjectItem(WebIServerSession session,
                                      java.lang.String projectName)
                               throws WebObjectsException

Returns a WebLinkItem for the specific user and explicitly specified project

Parameters:

session -

Returns:

a WebLinkItem for the specific user and project

Throws:

WebObjectsException

Since:

MicroStrategy Web 8.0.0