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

All Known Subinterfaces:

ActivationConfig, AppClient, Application, AuthConstraint, CmpField, CmrField, ComponentInterface, ContainerTransaction, Ejb, EjbJar, EjbLocalRef, EjbRef, EjbRelation, EjbRelationshipRole, Entity, EntityAndSession, EnvEntry, Filter, InitParam, JspPropertyGroup, Listener, MessageDestination, MessageDestinationRef, MessageDriven, Method, Query, RelationshipRoleSource, Relationships, ResourceEnvRef, ResourceRef, RootInterface, RunAs, SecurityIdentity, SecurityRole, SecurityRoleRef, ServiceRef, ServiceRefHandler, Servlet, Session, UserDataConstraint, WebApp, WebResourceCollection

public interface DescriptionInterface

Super interface for all DD elements having the description property/properties.

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

Method Summary

Map	getAllDescriptions() Returns all description elements in the form of <@link java.util.Map>.
String	getDefaultDescription() Returns the description element value for default locale.
String	getDescription(String locale) Returns the description element value for particular locale. If locale=null method returns description for default locale.
void	removeAllDescriptions() Removes all description elements from DD element.
void	removeDescription() Removes description element for default locale.
void	removeDescriptionForLocale(String locale) Removes the description element for particular locale.
void	setAllDescriptions(Map descriptions) Sets the multiple description elements.
void	setDescription(String description) Sets the description element without xml:lang attribute.
void	setDescription(String locale, String description) Sets the description element for particular locale. If locale=null the method sets the description element without xml:lang attribute. If description=null method removes the description element for a specified locale.

Method Detail

setDescription

void setDescription(String locale,
                    String description)
                    throws VersionNotSupportedException

Sets the description element for particular locale.
If locale=null the method sets the description element without xml:lang attribute.
If description=null method removes the description element for a specified locale.

Parameters:

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

description - value for description element

Throws:

VersionNotSupportedException

setDescription

void setDescription(String description)

Sets the description element without xml:lang attribute.

Parameters:

description - value for description element

setAllDescriptions

void setAllDescriptions(Map descriptions)
                        throws VersionNotSupportedException

Sets the multiple description elements.

Parameters:

descriptions - Map of descriptions in the form of [locale,description]

Throws:

VersionNotSupportedException

getDescription

String getDescription(String locale)
                      throws VersionNotSupportedException

Returns the description element value for particular locale.
If locale=null method returns description for default locale.

Parameters:

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

Returns:

description element value or null if not specified for given locale

Throws:

VersionNotSupportedException

getDefaultDescription

String getDefaultDescription()

Returns the description element value for default locale.

Returns:

description element value or null if not specified for default locale

getAllDescriptions

Map getAllDescriptions()

Returns all description elements in the form of <@link java.util.Map>.

Returns:

map of all descriptions in the form of [locale:description]

removeDescriptionForLocale

void removeDescriptionForLocale(String locale)
                                throws VersionNotSupportedException

Removes the description element for particular locale. If locale=null the method removes the description element for default locale.

Parameters:

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

Throws:

VersionNotSupportedException

removeDescription

void removeDescription()

Removes description element for default locale.

removeAllDescriptions

void removeAllDescriptions()

Removes all description elements from DD element.