com.sssw.portal.api
Interface EbiStyleManager

public interface EbiStyleManager

This provides an interface for the portal style manager.

Method Summary

boolean	clearStylesFromCache() Clears the styles from cache.
Document	getStyle(EbiPortalContext context, com.sssw.portal.api.EbiDevice device, String styleID) Gets a style sheet as a DOM object.
Document	getStyle(EbiPortalContext context, com.sssw.portal.api.EbiDevice device, String styleID, boolean flush) Gets a style sheet as a DOM object.
Document	getStyle(EbiPortalContext context, String styleID) Gets a style sheet as a DOM object.
Document	getStyle(EbiPortalContext context, String styleID, boolean flush) Gets a style sheet as a DOM object.
EbiCategoryInfo	getStyleCategoryInfo(EbiPortalContext context, String categoryName, boolean flush) Gets a style category info.
EbiCategoryInfo[]	getStyleCategoryInfoList(EbiPortalContext context) Gets a list of style categories info.
EbiStyleInfo	getStyleInfo(EbiPortalContext context, String styleID) Gets a style info object.
EbiStyleInfo	getStyleInfo(EbiPortalContext context, String styleID, boolean flush) Gets a style info object.
EbiStyleInfo[]	getStyleInfoList(EbiPortalContext context, String categoryName) Gets a list of EbiStyleInfo objects in a specific category.

Method Detail

getStyle

public Document getStyle(EbiPortalContext context,
                         String styleID,
                         boolean flush)
                  throws EboUnrecoverableSystemException

Gets a style sheet as a DOM object. The actual style that is returned depends on current device making the request.

Parameters:

context - a context.

styleID - a style id.

flush - true if it should flush the cache and reget from resourceset.

Returns:

a DOM object which is the style sheet

getStyle

public Document getStyle(EbiPortalContext context,
                         String styleID)
                  throws EboUnrecoverableSystemException

Gets a style sheet as a DOM object. The actual style that is returned depends on current device making the request.

Parameters:

context - a context.

styleID - a style id.

Returns:

a DOM object which is the style sheet

getStyle

public Document getStyle(EbiPortalContext context,
                         com.sssw.portal.api.EbiDevice device,
                         String styleID,
                         boolean flush)
                  throws EboUnrecoverableSystemException

Gets a style sheet as a DOM object. The actual style that is returned depends on device passed in.

Parameters:

context - a context.

device - a specific device

styleID - a style id.

flush - true if needs to flush the cache and reget from resourceset.

Returns:

a DOM representing the style

getStyle

public Document getStyle(EbiPortalContext context,
                         com.sssw.portal.api.EbiDevice device,
                         String styleID)
                  throws EboUnrecoverableSystemException

Gets a style sheet as a DOM object. The actual style that is returned depends on device passed in.

Parameters:

context - a context.

device - a specific device

styleID - a style id.

Returns:

a DOM representing the style

getStyleInfo

public EbiStyleInfo getStyleInfo(EbiPortalContext context,
                                 String styleID,
                                 boolean flush)
                          throws EboUnrecoverableSystemException

Gets a style info object.

Parameters:

context - a context.

styleID - a style ID

flush - true, flush the cache and re-get style info from resourceset

Returns:

an EbiStyleInfo object for the specified style.

getStyleInfo

public EbiStyleInfo getStyleInfo(EbiPortalContext context,
                                 String styleID)
                          throws EboUnrecoverableSystemException

Gets a style info object.

Parameters:

context - a context.

styleID - a style ID

Returns:

an EbiStyleInfo object for the specified style.

getStyleInfoList

public EbiStyleInfo[] getStyleInfoList(EbiPortalContext context,
                                       String categoryName)
                                throws EboUnrecoverableSystemException

Gets a list of EbiStyleInfo objects in a specific category. If category is null all styles will be returned.

Parameters:

context - a context

categoryName - a style category

Returns:

an array of EbiStyleInfo objects

getStyleCategoryInfo

public EbiCategoryInfo getStyleCategoryInfo(EbiPortalContext context,
                                            String categoryName,
                                            boolean flush)
                                     throws EboUnrecoverableSystemException

Gets a style category info.

Parameters:

context - a context.

categoryName - a name of the specified category.

flush - true if needs to re-get component category info from resourceset.

Returns:

an EbiCategoryInfo object.

getStyleCategoryInfoList

public EbiCategoryInfo[] getStyleCategoryInfoList(EbiPortalContext context)
                                           throws EboUnrecoverableSystemException

Gets a list of style categories info.

Parameters:

context - a context.

Returns:

an array of EbiCategoryInfo objects for style categories.

clearStylesFromCache

public boolean clearStylesFromCache()
                             throws EboUnrecoverableSystemException

Clears the styles from cache.

Returns:

true if the styles are removed from server-lifetime cache successfully.