Package lumis.portal.serviceinterface.style

Class ServiceInterfaceStyleManager

java.lang.Object

lumis.portal.serviceinterface.style.ServiceInterfaceStyleManager

All Implemented Interfaces:

IServiceInterfaceStyleManager

public class ServiceInterfaceStyleManager
extends java.lang.Object
implements IServiceInterfaceStyleManager

Manages the interface styles.

Since:

8.1.0

Version:

$Revision: 25159 $ $Date: 2022-07-31 15:54:42 -0300 (Sun, 31 Jul 2022) $

Constructor Summary

Constructors

Constructor	Description
ServiceInterfaceStyleManager()

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.

Methods inherited from class java.lang.Object

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

Constructor Detail

ServiceInterfaceStyleManager

public ServiceInterfaceStyleManager()

Method Detail

addStyleCacheConfig

public void addStyleCacheConfig(StyleCacheConfig styleCacheConfig)
                         throws PortalException,
                                ManagerException

Description copied from interface: IServiceInterfaceStyleManager

Add a cache of the style.

Specified by:

addStyleCacheConfig in interface IServiceInterfaceStyleManager

Throws:

PortalException

ManagerException

deleteStyleCacheConfig

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

Description copied from interface: IServiceInterfaceStyleManager

Delete the cache of the style.

Specified by:

deleteStyleCacheConfig in interface IServiceInterfaceStyleManager

Throws:

PortalException

ManagerException

updateStyleCacheConfig

public void updateStyleCacheConfig(StyleCacheConfig styleCacheConfig)
                            throws PortalException,
                                   ManagerException

Description copied from interface: IServiceInterfaceStyleManager

Update the cache of the style.

Specified by:

updateStyleCacheConfig in interface IServiceInterfaceStyleManager

Throws:

PortalException

ManagerException

getStyleCacheConfig

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

Description copied from interface: IServiceInterfaceStyleManager

Get the styleCacheConfig.

Specified by:

getStyleCacheConfig in interface IServiceInterfaceStyleManager

Returns:

a styleCacheConfig.

Throws:

PortalException

ManagerException

clearStyleCache

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

Description copied from interface: IServiceInterfaceStyleManager

Clear the cache for the specified style file.

Specified by:

clearStyleCache in interface IServiceInterfaceStyleManager

Parameters:

fileName - the style file path.

Throws:

PortalException

ManagerException

clearStyleCache

public void clearStyleCache(ITransaction transaction)
                     throws PortalException

Description copied from interface: IServiceInterfaceStyleManager

Clears all style cache.

Specified by:

clearStyleCache in interface IServiceInterfaceStyleManager

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

clearStyleCacheByThemeId

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

Description copied from interface: IServiceInterfaceStyleManager

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

Specified by:

clearStyleCacheByThemeId in interface IServiceInterfaceStyleManager

Parameters:

themeId - the theme identifier.

Throws:

PortalException

isStyleCached

public boolean isStyleCached(java.lang.String fileName)

Description copied from interface: IServiceInterfaceStyleManager

Verify if the style file is cached.

Specified by:

isStyleCached in interface IServiceInterfaceStyleManager

Parameters:

fileName - the style file path.

Returns:

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

getCachedStyle

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

Description copied from interface: IServiceInterfaceStyleManager

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

Specified by:

getCachedStyle in interface IServiceInterfaceStyleManager

Parameters:

stylePath - the style path.

Returns:

the cached version of the style in the given path.

Throws:

PortalException

getCachedStyle

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

Description copied from interface: IServiceInterfaceStyleManager

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

Specified by:

getCachedStyle in interface IServiceInterfaceStyleManager

Parameters:

stylePath - the style path.

themes - the list of applied themes.

Returns:

the cached version of the style in the given path.

Throws:

PortalException

getDynamicStyle

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

Description copied from interface: IServiceInterfaceStyleManager

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

Specified by:

getDynamicStyle in interface IServiceInterfaceStyleManager

Parameters:

stylePath - the style path.

Returns:

the cached version of the style in the given path.

Throws:

PortalException

getDynamicStyle

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

Description copied from interface: IServiceInterfaceStyleManager

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

Specified by:

getDynamicStyle in interface IServiceInterfaceStyleManager

Parameters:

stylePath - the style path.

themes - the list of applied themes.

Returns:

the cached version of the style in the given path.

Throws:

PortalException

getDynamicStyle

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

Description copied from interface: IServiceInterfaceStyleManager

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

Specified by:

getDynamicStyle in interface IServiceInterfaceStyleManager

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