com.novell.afw.portlet.api
Interface EbiPortletModel

All Known Subinterfaces:

EbiNovellPortletModel

public interface EbiPortletModel

The EbiPortletModel interface provides information from a portlet (or a component) deployment descriptor.

Since:

v5.0

See Also:

EbiProxyConstants, javax.portlet.PortletConfig, EbiPortalComponentInfo

Field Summary

static String

EL_PORTLET_MODEL Element Type

Method Summary

String	getDescription(Locale locale) Returns a localized description of the portlet.
String	getDisplayName(Locale locale) Returns a localized display name of the portlet.
String	getPortletAppContextName() Returns the portlet application context name of a WAR that the specified portlet (or component) is located.
String	getPortletClassName() Returns the portlet class name.
String	getPortletContainerType() Gets the type of the portlet container where this portlet belongs.
String	getPortletName() Gets the portlet Name.
String	getPreviewImage(Locale locale) Returns the URL of the preview image for the given locale.
String	getProducerID() Returns the producer ID for a specified portlet (definition, i.e.
Collection	getStyles() Returns a Collection of PortletStyles available to this portlet.
Collection	getSupportedMimeTypes() Returns an Collection of strings that represent the supported mime types.
String[]	getSupportedOptions() Returns a list of all options declared in the novell-portlet.xml that are have the enabled attribute set to "true" OR have not specified the enabled attribute so as to mean enabled="true".
String	getTitle(Locale locale) Gets portlet title for a given locale from the deployment descriptor.
boolean	isTitleBarEnabled() Indicates whether the title bar should be displayed by the portal.

Field Detail

EL_PORTLET_MODEL

public static final String EL_PORTLET_MODEL

Element Type

Since:

v5.0

Method Detail

getProducerID

public String getProducerID()

Returns the producer ID for a specified portlet (definition, i.e. a portlet deployment description). For a local portlet or component, the producer ID is the context name of the associated WAR (portlet application). For a remote portlet (WSRP) the producer ID is a registration handle (if wsrp consumer registration is required) or a producer URL (where the wsrp producer is located.)

Returns:

the producer ID.

Since:

v5.0

getPortletAppContextName

public String getPortletAppContextName()

Returns the portlet application context name of a WAR that the specified portlet (or component) is located.

Returns:

the portlet application context name.

Since:

v5.0

getPortletName

public String getPortletName()

Gets the portlet Name. The portlet Name is defined in the portlet deployment descriptor, and is unique within a portlet application.

Returns:

the portlet name.

Since:

v5.0

getPortletClassName

public String getPortletClassName()

Returns the portlet class name. The portlet container needs the portlet class name for administration purposes.

Returns:

the portlet class name

Since:

v5.0

getDescription

public String getDescription(Locale locale)

Returns a localized description of the portlet. Descriptions are localized by specifying the xml:lang attribute for the description. When a locale is passed in, a search for the most appropriate locale is done if an exact match can not be found. See section PLT.21.8.1 of the portlet spec for more details on how descriptor values are localized.

Parameters:

locale - Locale for which to return the description, or null to mean the default.

Returns:

String with the localized description.

Since:

v5.0

getTitle

public String getTitle(Locale locale)

Gets portlet title for a given locale from the deployment descriptor.

Parameters:

locale - Locale for which the result should be localized, null for the default.

Returns:

String localized title for the portlet, or null if none specified.

Since:

v5.0

getDisplayName

public String getDisplayName(Locale locale)

Returns a localized display name of the portlet. Display names are localized by specifying the xml:lang attribute for the display-name tag. When a locale is passed in, a search for the most appropriate locale is done if an exact match can not be found. See section PLT.21.8.1 of the portlet spec for more details on how descriptor values are localized.

Parameters:

locale - Locale for which to return the display-name, or null to mean the default.

Returns:

String with the localized display-name.

Since:

v5.0

getSupportedMimeTypes

public Collection getSupportedMimeTypes()

Returns an Collection of strings that represent the supported mime types.

Returns:

an Collection of String objects

Since:

v5.0

getPortletContainerType

public String getPortletContainerType()

Gets the type of the portlet container where this portlet belongs.

Returns:

type of the associate portlet container. The cotnainer types are defined in ProxyConstants.

Since:

v5.0

See Also:

EbiProxyConstants

isTitleBarEnabled

public boolean isTitleBarEnabled()

Indicates whether the title bar should be displayed by the portal.

Returns:

true if the title bar should be rendered, false if not specified.

Since:

v5.0

getPreviewImage

public String getPreviewImage(Locale locale)

Returns the URL of the preview image for the given locale. This image can be used by the front end to show what the rendered portlet might look like. If a preview image for the specified locale is not found or locale is null, the default preview image will be returned, or null if that is not specified.

Parameters:

locale - Locale for which to return the preview image, or null for the default.

Returns:

String with the URL to the preview image, or null if none specified.

Since:

v5.0

getStyles

public Collection getStyles()

Returns a Collection of PortletStyles available to this portlet.

Returns:

Collection of PortletStyles available to this portlet.

Since:

v5.0

getSupportedOptions

public String[] getSupportedOptions()

Returns a list of all options declared in the novell-portlet.xml that are have the enabled attribute set to "true" OR have not specified the enabled attribute so as to mean enabled="true". Options specified with the enabled attribute set to "false" will not be returned.

Returns:

String[] of options that the portlet supports. For each element of the returned array isOptionSupported(element)==true. Returns null if no options were specified at all.

Since:

v5.0