public interface DisplayNameInterface
Important note: Do not provide an implementation of this interface unless you are a DD API provider!
Modifier and Type | Method and Description |
---|---|
Map |
getAllDisplayNames()
Returns all display-name elements in the form of
Map . |
String |
getDefaultDisplayName()
Returns the display-name element value for default locale.
|
String |
getDisplayName(String locale)
Returns the display-name element value for particular locale.
If locale=null method returns display-name for default locale. |
void |
removeAllDisplayNames()
Removes all display-name elements from DD element.
|
void |
removeDisplayName()
Removes display-name element for default locale.
|
void |
removeDisplayNameForLocale(String locale)
Removes the display-name element for particular locale.
|
void |
setAllDisplayNames(Map displayNames)
Sets the multiple display-name elements.
|
void |
setDisplayName(String displayName)
Sets the display-name element without xml:lang attribute.
|
void |
setDisplayName(String locale,
String displayName)
Sets the display-name element value for particular locale.
If locale=null the method sets the display-name element without xml:lang attribute. If displayName=null method removes the display-name element for a specified locale. |
void setDisplayName(String locale, String displayName) throws VersionNotSupportedException
locale
- string representing the locale - the value for xml:lang attribute e.g. "fr"displayName
- value for display-name elementVersionNotSupportedException
void setDisplayName(String displayName)
displayName
- value for display-name elementvoid setAllDisplayNames(Map displayNames) throws VersionNotSupportedException
displayNames
- Map of display names in the form of [locale,display-name]VersionNotSupportedException
String getDisplayName(String locale) throws VersionNotSupportedException
locale
- string representing the locale - the value of xml:lang attribute e.g. "fr".VersionNotSupportedException
String getDefaultDisplayName()
Map getAllDisplayNames()
Map
.void removeDisplayNameForLocale(String locale) throws VersionNotSupportedException
locale
- string representing the locale - the value of xml:lang attribute e.g. "fr"VersionNotSupportedException
void removeDisplayName()
void removeAllDisplayNames()