com.sssw.portal.api
Interface EbiStyleInfo

All Superinterfaces:

Cloneable, EbiElement, EbiFrameworkElement, Serializable

public interface EbiStyleInfo

extends EbiFrameworkElement

This provides an interface for style info from PortalStyles table.

Field Summary

static String

EL_PORTAL_STYLE style element type

Method Summary

String	getStyleCategory() Deprecated. getStyleCategories()
String	getStyleDescription() Gets the style's description.
String	getStyleDescriptor() Deprecated. Do not use this method since it treats the XML document as a string which can introduce problems with proper encoding and can also lead to unneeded parsing and serializing. Use getStyleDescriptorDocument() in its stead.
Document	getStyleDescriptorDocument() Returns the DOM for the style descriptor.
String	getStyleDisplayName() Returns the styles display name
String	getStyleDpFileID(EbiPortalContext context) Gets the style's file sheet ID (The file name of the stlyesheet e.g.
String	getStyleDpFileID(String deviceName) Deprecated. EbiStyleInfo.getgetStyleDpFileID(EbiPortalContext)
String	getStyleFileID(EbiPortalContext context) Gets the style's file sheet ID (The file name of the stlyesheet e.g.
String	getStyleFileID(String deviceName) Deprecated. EbiStyleInfo.getStyleFileID(EbiPortalContext)
String	getStyleID() Gets the style identifier.
String[]	getStyleUserAgents() Gets a list of supported user-agents (devices) for this style
boolean	hasUserAgent(String userAgent) Determines if this style supports a particular user-agent

Methods implemented from interface com.sssw.fw.api.EbiFrameworkElement

getElementUUID, getLastModified, getLastModifiedBy, isEqualTo, isReadOnly, resetReadOnly, setLastModified, setLastModifiedBy, setReadOnly

Methods implemented from interface com.sssw.fw.api.EbiElement

getType

Field Detail

EL_PORTAL_STYLE

public static final String EL_PORTAL_STYLE

style element type

Method Detail

getStyleDescriptor

public String getStyleDescriptor()

Deprecated. Do not use this method since it treats the XML document as a string which can introduce problems with proper encoding and can also lead to unneeded parsing and serializing. Use getStyleDescriptorDocument() in its stead.

Returns the styles xml descriptor.

Returns:

an xml document as a string of the descriptor

See Also:

EbiStyleInfo.getStyleDescriptorDocument()

getStyleDescriptorDocument

public Document getStyleDescriptorDocument()

Returns the DOM for the style descriptor. The DOM returned will be a preparsed document. This document should be treated as read only.

Returns:

The DOM representation of the descriptor. This can be null if the the xml could not be parsed.

Since:

5.2

getStyleDisplayName

public String getStyleDisplayName()

Returns the styles display name

Returns:

the style display name

getStyleID

public String getStyleID()

Gets the style identifier.

Returns:

a style identifier String.

hasUserAgent

public boolean hasUserAgent(String userAgent)

Determines if this style supports a particular user-agent

Parameters:

userAgent -

Returns:

boolean

getStyleUserAgents

public String[] getStyleUserAgents()

Gets a list of supported user-agents (devices) for this style

Returns:

an array of user-agents represented as strings.

getStyleFileID

public String getStyleFileID(String deviceName)

Deprecated. EbiStyleInfo.getStyleFileID(EbiPortalContext)

Gets the style's file sheet ID This is used to retrieve the actual style content from the resource set.

Parameters:

deviceName -

Returns:

the name of the file (e.g. PhoneList_IE.xsl)

getStyleDpFileID

public String getStyleDpFileID(String deviceName)

Deprecated. EbiStyleInfo.getgetStyleDpFileID(EbiPortalContext)

Gets the style's device profiling file sheet ID This is used to retrieve the actual style content from the resource set.

Parameters:

deviceName -

Returns:

the name of the file (e.g. PhoneList_Nokia.xsl)

getStyleFileID

public String getStyleFileID(EbiPortalContext context)

Gets the style's file sheet ID (The file name of the stlyesheet e.g. PhoneListStyle.xsl) Note: This style sheet is based on the user-agents (devices) listed in the style descriptor. If a specific user-agent is not listed in the style descriptoe, this method will try to find a generic device that supports the current contentType and then find the styleshett file name.

Parameters:

context -

Returns:

the name of the file (e.g. PhoneList_IE.xsl)

getStyleDpFileID

public String getStyleDpFileID(EbiPortalContext context)

Gets the style's file sheet ID (The file name of the stlyesheet e.g. PhoneListStyle.xsl) This file is used when transcoding the content of a portlet. Note: This style sheet is based on the user-agents (devices) listed in the style descriptor. If a specific user-agent is not listed in the style descriptoe, this method will try to find a generic device that supports the current contentType and then find the styleshett file name.

Parameters:

context -

Returns:

the name of the file (e.g. PhoneList_Nokia.xsl)

getStyleDescription

public String getStyleDescription()

Gets the style's description.

Returns:

style's description.

getStyleCategory

public String getStyleCategory()

Deprecated. getStyleCategories()

Gets the style's category. Returns the first category of from the list of categories this style belongs to.

Returns:

style's first category