Package lumis.portal.serviceinterface.style

Interface IServiceInterfaceStyleManager

All Known Implementing Classes:

ServiceInterfaceStyleManager

public interface IServiceInterfaceStyleManager

Since:

8.1.0

Version:

$Revision: 25303 $ $Date: 2022-10-22 22:48:02 -0300 (Sat, 22 Oct 2022) $

Method Summary

Modifier and Type	Method	Description
void	addStyleCacheConfig(StyleCacheConfig styleCacheConfig)	Add a cache of the style.
void	clearStyleCache(java.lang.String fileName)	Clear the cache for the specified style file.
void	clearStyleCache(ITransaction transaction)	Clears all style cache.
void	clearStyleCacheByThemeId(java.lang.String themeId)	Clears the cache for the styles that may be used by the given theme.
void	deleteStyleCacheConfig(java.lang.String fileName)	Delete the cache of the style.
IStyle	getCachedStyle(java.lang.String stylePath)	Returns the cached version of the style in the given path.
IStyle	getCachedStyle(java.lang.String stylePath, java.util.List<ITheme> themes)	Returns the cached version of the style in the given path.
IStyle	getDynamicStyle(java.lang.String stylePath)	Returns the dynamic version of the style in the given path.
IStyle	getDynamicStyle(java.lang.String styleString, java.lang.String stylePath, java.util.List<ITheme> themes)	Returns the cached version of the style in the given path.
IStyle	getDynamicStyle(java.lang.String stylePath, java.util.List<ITheme> themes)	Returns the dynamic version of the style in the given path.
StyleCacheConfig	getStyleCacheConfig(java.lang.String fileName)	Get the styleCacheConfig.
boolean	isStyleCached(java.lang.String fileName)	Verify if the style file is cached.
void	updateStyleCacheConfig(StyleCacheConfig styleCacheConfig)	Update the cache of the style.

Method Detail

addStyleCacheConfig

void addStyleCacheConfig(StyleCacheConfig styleCacheConfig)
                  throws PortalException,
                         ManagerException

Add a cache of the style.

Parameters:

sessionConfig -

styleCacheConfig -

transaction -

Throws:

PortalException

ManagerException

deleteStyleCacheConfig

void deleteStyleCacheConfig(java.lang.String fileName)
                     throws PortalException,
                            ManagerException

Delete the cache of the style.

Parameters:

sessionConfig -

fileName -

transaction -

Throws:

PortalException

ManagerException

updateStyleCacheConfig

void updateStyleCacheConfig(StyleCacheConfig styleCacheConfig)
                     throws PortalException,
                            ManagerException

Update the cache of the style.

Parameters:

sessionConfig -

styleCacheConfig -

transaction -

Throws:

PortalException

ManagerException

getStyleCacheConfig

StyleCacheConfig getStyleCacheConfig(java.lang.String fileName)
                              throws PortalException,
                                     ManagerException

Get the styleCacheConfig.

Parameters:

sessionConfig -

fileName -

transaction -

Returns:

a styleCacheConfig.

Throws:

PortalException

ManagerException

clearStyleCache

void clearStyleCache(java.lang.String fileName)
              throws PortalException,
                     ManagerException

Clear the cache for the specified style file.

Parameters:

sessionConfig - the user session information.

fileName - the style file path.

transaction - the transaction for persistence access.

Throws:

PortalException

ManagerException

clearStyleCache

void clearStyleCache(ITransaction transaction)
              throws PortalException

Clears all style cache.

Parameters:

transaction - the transaction for persistence access. If null, the cache is just cleared, else it is cleared as a transactional operation as specified in lumis.portal.cache.PortalCache#clear(ITransaction).

Throws:

PortalException

Since:

8.1.0

clearStyleCacheByThemeId

void clearStyleCacheByThemeId(java.lang.String themeId)
                       throws PortalException

Clears the cache for the styles that may be used by the given theme.

Parameters:

themeId - the theme identifier.

Throws:

PortalException

Since:

15.0.0

isStyleCached

boolean isStyleCached(java.lang.String fileName)

Verify if the style file is cached.

Parameters:

fileName - the style file path.

Returns:

true if any variant of the style is being cached, or false otherwise.

getCachedStyle

IStyle getCachedStyle(java.lang.String stylePath)
               throws PortalException

Returns the cached version of the style in the given path.

Parameters:

stylePath - the style path.

Returns:

the cached version of the style in the given path.

Throws:

PortalException

Since:

8.1.0

getCachedStyle

IStyle getCachedStyle(java.lang.String stylePath,
                      java.util.List<ITheme> themes)
               throws PortalException

Returns the cached version of the style in the given path.

Parameters:

stylePath - the style path.

themes - the list of applied themes.

Returns:

the cached version of the style in the given path.

Throws:

PortalException

Since:

8.1.0

getDynamicStyle

IStyle getDynamicStyle(java.lang.String stylePath)
                throws PortalException

Returns the dynamic version of the style in the given path.

Parameters:

stylePath - the style path.

Returns:

the cached version of the style in the given path.

Throws:

PortalException

Since:

8.1.0

getDynamicStyle

IStyle getDynamicStyle(java.lang.String stylePath,
                       java.util.List<ITheme> themes)
                throws PortalException

Returns the dynamic version of the style in the given path.

Parameters:

stylePath - the style path.

themes - the list of applied themes.

Returns:

the cached version of the style in the given path.

Throws:

PortalException

Since:

8.1.0

getDynamicStyle

IStyle getDynamicStyle(java.lang.String styleString,
                       java.lang.String stylePath,
                       java.util.List<ITheme> themes)
                throws PortalException

Returns the cached version of the style in the given path.

Parameters:

styleString - the style text.

stylePath - the style path.

themes - the list of applied themes.

Returns:

the cached version of the style in the given path.

Throws:

PortalException

Since:

8.1.0