org.apache.wookie.w3c
Interface W3CWidget

All Superinterfaces:

IElement, ILocalizedElement, ILocalizedEntity

All Known Implementing Classes:

WidgetManifestModel

public interface W3CWidget
extends ILocalizedEntity

A W3C Widget object This represents the information model for a W3C widget that has been unpacked using the W3CWidgetFactory.

Method Summary

java.util.List<IAccessEntity>	getAccessList() Get the list of access request entities for the widget
IAuthorEntity	getAuthor() Get the Author information for the widget
java.util.List<IContentEntity>	getContentList() Get the list of start pages for the widget
java.lang.String	getDefaultLocale() Get the default locale
java.util.List<IDescriptionEntity>	getDescriptions() Get the list of Descriptions for the widget
java.util.List<IFeatureEntity>	getFeatures() Get a list of Features requested by the widget.
java.lang.Integer	getHeight() Get the widget height as an Integer.
java.util.List<IIconEntity>	getIconsList() Get the list of icons for the widget
java.lang.String	getIdentifier() Get the widget identifier (IRI)
java.util.List<ILicenseEntity>	getLicensesList() Get the list of Licenses for the widget
java.lang.String	getLocalName(java.lang.String locale) A convenience method typically used for generating debug messages during import.
java.util.List<INameEntity>	getNames() Get the list of Names for the widget
java.util.List<IPreferenceEntity>	getPrefences() Get the list of Preferences defined for the widget
java.lang.String	getUpdate()
java.lang.String	getVersion() Get the version of the widget
java.lang.String	getViewModes() Gets the widget viewmodes attribute.
java.lang.Integer	getWidth() Get the widget width as an Integer.

Methods inherited from interface org.apache.wookie.w3c.ILocalizedEntity

getDir, isValid

Methods inherited from interface org.apache.wookie.w3c.IElement

fromXML, toXml

Methods inherited from interface org.apache.wookie.w3c.ILocalizedElement

getLang, setLang

Method Detail

getDefaultLocale

java.lang.String getDefaultLocale()

Get the default locale

Returns:

a locale string, or Null if no default locale is specified

getAccessList

java.util.List<IAccessEntity> getAccessList()

Get the list of access request entities for the widget

getContentList

java.util.List<IContentEntity> getContentList()

Get the list of start pages for the widget

getIconsList

java.util.List<IIconEntity> getIconsList()

Get the list of icons for the widget

getIdentifier

java.lang.String getIdentifier()

Get the widget identifier (IRI)

getLicensesList

java.util.List<ILicenseEntity> getLicensesList()

Get the list of Licenses for the widget

getNames

java.util.List<INameEntity> getNames()

Get the list of Names for the widget

getDescriptions

java.util.List<IDescriptionEntity> getDescriptions()

Get the list of Descriptions for the widget

getHeight

java.lang.Integer getHeight()

Get the widget height as an Integer. Note this may be Null.

getWidth

java.lang.Integer getWidth()

Get the widget width as an Integer. Note this may be Null.

getAuthor

IAuthorEntity getAuthor()

Get the Author information for the widget

getPrefences

java.util.List<IPreferenceEntity> getPrefences()

Get the list of Preferences defined for the widget

getFeatures

java.util.List<IFeatureEntity> getFeatures()

Get a list of Features requested by the widget. Note that only valid features are included (e.g. ones supported by the platform, or that are defined by the widget as optional)

getVersion

java.lang.String getVersion()

Get the version of the widget

getViewModes

java.lang.String getViewModes()

Gets the widget viewmodes attribute. A keyword list attribute that denotes the author's preferred view mode, followed by the next most preferred view mode and so forth

getLocalName

java.lang.String getLocalName(java.lang.String locale)

A convenience method typically used for generating debug messages during import. This method will never return null, however the name may be an empty String. This is equivalent to: List names = widget.getNames(); INameEntity name = (INameEntity)LocalizationUtils.getLocalizedElement(names.toArray(new INameEntity[fNamesList.size()]), new String[]{"en"});

Parameters:

locale -

Returns:

the name of the widget to be used in the given locale

getUpdate

java.lang.String getUpdate()

Returns:

the update description document URL for the widget, or null if no valid update URL has been set