org.netbeans.modules.j2ee.dd.api.common
Interface DisplayNameInterface

All Known Subinterfaces:

AppClient, Application, ComponentInterface, Ejb, EjbJar, Entity, EntityAndSession, Filter, JspPropertyGroup, Listener, MessageDestination, MessageDriven, RootInterface, SecurityConstraint, ServiceRef, ServiceRefHandler, Servlet, Session, WebApp

public interface DisplayNameInterface

Super interface for all DD elements having the display-name property/properties.

Important note: Do not provide an implementation of this interface unless you are a DD API provider!

Method Summary

Map	getAllDisplayNames() Returns all display-name elements in the form of <@link java.util.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.

Method Detail

setDisplayName

void setDisplayName(String locale,
                    String displayName)
                    throws VersionNotSupportedException

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.

Parameters:

locale - string representing the locale - the value for xml:lang attribute e.g. "fr"

displayName - value for display-name element

Throws:

VersionNotSupportedException

setDisplayName

void setDisplayName(String displayName)

Sets the display-name element without xml:lang attribute.

Parameters:

displayName - value for display-name element

setAllDisplayNames

void setAllDisplayNames(Map displayNames)
                        throws VersionNotSupportedException

Sets the multiple display-name elements.

Parameters:

displayNames - Map of display names in the form of [locale,display-name]

Throws:

VersionNotSupportedException

getDisplayName

String getDisplayName(String locale)
                      throws VersionNotSupportedException

Returns the display-name element value for particular locale.
If locale=null method returns display-name for default locale.

Parameters:

locale - string representing the locale - the value of xml:lang attribute e.g. "fr".

Returns:

display-name element value or null if not specified for given locale

Throws:

VersionNotSupportedException

getDefaultDisplayName

String getDefaultDisplayName()

Returns the display-name element value for default locale.

Returns:

display-name element value or null if not specified for default locale

getAllDisplayNames

Map getAllDisplayNames()

Returns all display-name elements in the form of <@link java.util.Map>.

Returns:

map of all display-names in the form of [locale:display-name]

removeDisplayNameForLocale

void removeDisplayNameForLocale(String locale)
                                throws VersionNotSupportedException

Removes the display-name element for particular locale. If locale=null the method removes the display-name element for default locale.

Parameters:

locale - string representing the locale - the value of xml:lang attribute e.g. "fr"

Throws:

VersionNotSupportedException

removeDisplayName

void removeDisplayName()

Removes display-name element for default locale.

removeAllDisplayNames

void removeAllDisplayNames()

Removes all display-name elements from DD element.