|
Novell exteNd Director 5.2 API |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Interface that represents a collection of preferences that can be expressed as XML. Subclasses will further define methods to manipulate the preference objects.
Method Summary | |
List |
getAllPreferences(Locale locale)
Returns a List with all the preferences in the given locale. |
String |
getDisplayableXML(Locale locale)
Deprecated. Use EboPortletPreferencesDisplayHelper.getDisplayableXML() to produce these results. |
EbiPortletPreferences |
getParentPreferences()
Returns the parent level preferences. |
EbiPortletPreference |
getPreference(String name,
Locale locale)
Returns a preference by name and locale. |
Map |
getPreferenceMap(Locale locale)
Returns a Map with all the preferences for a given locale keyed by the preference name. |
boolean |
isPreferenceInherited(EbiPortletPreference pref)
Indicates if the preference passed comes directly from this level of preferences, or if it is a value that is inherited from a lower level. |
StringBuffer |
toXML(boolean composite)
Returns an XML document representing the preferences. |
Method Detail |
public EbiPortletPreferences getParentPreferences()
public StringBuffer toXML(boolean composite) throws EboUnrecoverableSystemException
composite
- if true, the xml will represent all levels, otherwise
only the xml for the current level.
TODO: include xsd/sample xml
public String getDisplayableXML(Locale locale) throws EboUnrecoverableSystemException
locale
- The locale for which to display the preferences.com.novell.afw.portlet.util.EboPortletPreferenceDisplayHelper#getDisplayableXML(com.novell.afw.portlet.api.EbiPortletPreferences, com.sssw.fw.api.EbiContext)
,
com.novell.afw.portlet.util.EboPortletPreferenceDisplayHelper#getDisplayableXML(com.novell.afw.portlet.api.EbiPortletPreferences, java.util.Locale[])
public EbiPortletPreference getPreference(String name, Locale locale)
name
- String name of the preference.locale
- String locale of the preference. The locale
has the format lang || lang_COUNTRY || null.public List getAllPreferences(Locale locale)
locale
- Locale or null to mean the default locale.public Map getPreferenceMap(Locale locale)
locale
- Locale or null to mean the default locale.public boolean isPreferenceInherited(EbiPortletPreference pref)
pref
- The EbiPortletPreference to test.
|
Novell exteNd Director 5.2 API |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |