com.sssw.portal.api
Interface EbiThemeInfo

All Superinterfaces:

Cloneable, EbiElement, EbiFrameworkElement, Serializable

public interface EbiThemeInfo

extends EbiFrameworkElement

Value object for a theme

Field Summary

static String

EL_PORTAL_THEME theme element type

Method Summary

String	getThemeDescription() Gets the description of the theme
String	getThemeDescription(EbiPortalContext context) Gets the localized description of the theme
String	getThemeDisplayName() Gets the display name of the theme.
String	getThemeDisplayName(EbiPortalContext context) Gets the localized display name of the theme.
String	getThemeID() Gets the theme's unique identifier
String	getThemePreviewImage() Gets the URI of the preview image which represents the theme
String	getThemePreviewImage(EbiPortalContext context) Gets the URI of the preview image which represents the theme.
String	getThemeThumbnailImage() Gets the URI of the thumbnail image which represents the theme
String	getThemeThumbnailImage(EbiPortalContext context) Gets the URI of the thumbnail image which represents the theme

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_THEME

public static final String EL_PORTAL_THEME

theme element type

Method Detail

getThemeDescription

public String getThemeDescription()

Gets the description of the theme

Returns:

the description of the theme

getThemeDescription

public String getThemeDescription(EbiPortalContext context)

Gets the localized description of the theme

Parameters:

context - the portal context which carries the locale

Returns:

the loclized description of the theme

Since:

v5.0

getThemeDisplayName

public String getThemeDisplayName()

Gets the display name of the theme.

Returns:

the display name of the theme.

getThemeDisplayName

public String getThemeDisplayName(EbiPortalContext context)

Gets the localized display name of the theme.

Parameters:

context - the portal context which carries the locale

Returns:

the localized display name of the theme.

getThemeID

public String getThemeID()

Gets the theme's unique identifier

Returns:

the theme's identifier

getThemePreviewImage

public String getThemePreviewImage(EbiPortalContext context)

Gets the URI of the preview image which represents the theme.

Since the string may include substitution strings based on runtime information the context is required. The returned result is the result of runtime substitutions being perfromed on the original string set in teh descriptor.

Parameters:

context - the portal context

Returns:

a URI to the image

getThemeThumbnailImage

public String getThemeThumbnailImage(EbiPortalContext context)

Gets the URI of the thumbnail image which represents the theme

Since the string may include substitution strings based on runtime information the context is required. The returned result is the result of runtime substitutions being perfromed on the original string set in teh descriptor.

Parameters:

context - the portal context

Returns:

a URI to the image

getThemePreviewImage

public String getThemePreviewImage()

Gets the URI of the preview image which represents the theme

This method does not perform runtime substitutions. The result is simply the actual string that is in teh descriptor for this particular element

Returns:

a URI to the image

See Also:

EbiThemeInfo.getThemePreviewImage(EbiPortalContext)

getThemeThumbnailImage

public String getThemeThumbnailImage()

Gets the URI of the thumbnail image which represents the theme

This method does not perform runtime substitutions. The result is simply the actual string that is in teh descriptor for this particular element

Returns:

a URI to the image

See Also:

EbiThemeInfo.getThemeThumbnailImage(EbiPortalContext)