org.mmbase.bridge

Interface Descriptor

All Known Subinterfaces:

DataType<C>, Field, LengthDataType<E>, Module

All Known Implementing Classes:

AbstractDescriptor, AbstractField, AbstractLengthDataType, AbstractSendMail, BasicDataType, BasicField, BinaryDataType, BinaryStringDataType, BooleanDataType, cache, CALC, CaptchaDataType, CheckEqualityDataType, ClusteringModule, ComparableDataType, ComponentNamesDataType, ConfirmPasswordDataType, CoreField, CrontabModule, DataTypeField, DateTimeDataType, DecimalDataType, DescribedFunctionProvider, DoubleDataType, Duration.DataType, FieldDefs, FieldWrapper, FloatDataType, HtmlBase, INFO, IntegerDataType, InternetAddressDataType, JDBC, LanguageDataType, LinkChecker, ListDataType, LongDataType, Lucene, MMAdmin, MMBase, MMEdit, MMFlash, MMLanguage, MMUsers, MockField, MockNodeManager.SystemField, Module, ModuleHandler, MustBeTrueDataType, NodeDataType, NodeManagerNamesDataType, Notifier, NumberDataType, Parameter, Parameter.Wrapper, PasswordGeneratorModule, PatternParameter, ProcessorModule, ReloadableModule, RemoteDescriptor_Proxy, RemoteField_Proxy, RemoteMMCI, RemoteModule_Proxy, ReturnType, scancache, scanparser, SecurityContextDataType, SendMail, sessions, Setting.DataType, SMTPModule, StringDataType, TransactionHandler, TransactionHandler, UniqueStringDataType, Upload, UserNodeDataType, VirtualNodeManager.VirtualNodeManagerField, WatchedReloadableModule, WeekdaysDataType, XmlDataType, XSLConvert

public interface Descriptor

XXX A descriptor does not describe. It has descriptions. Perhaps 'UserPresentable'?

Since:

MMBase-1.8

Method Summary

Modifier and Type	Method and Description
String	getDescription() Returns the description of this object for the default locale.
String	getDescription(Locale locale) Returns the description of this object.
String	getGUIName() Returns the GUI name for this object.
String	getGUIName(Locale locale) Returns the GUI name for this object in a specified preferred language.
LocalizedString	getLocalizedDescription() Returns the set of (localized) descriptions of this object.
LocalizedString	getLocalizedGUIName() Returns the set of (localized) gui names of this object.
String	getName() Returns the name or 'key' of this object, or null if not applicable.
void	setDescription(String description) Sets the description of this object for the default locale.
void	setDescription(String description, Locale locale) Sets the description of this object.
void	setGUIName(String g) Sets the GUI name of this object for the default locale.
void	setGUIName(String g, Locale locale) Sets the GUI name of this object.

Method Detail

getName

String getName()

Returns the name or 'key' of this object, or null if not applicable.

Returns:

the name as a String

getGUIName

String getGUIName()

Returns the GUI name for this object.

Returns:

the GUI name for this object

getGUIName

String getGUIName(Locale locale)

Returns the GUI name for this object in a specified preferred language.

Parameters:

locale - the locale that determines the language for the GUI name

Returns:

the GUI name for this object

Since:

MMBase-1.7

getLocalizedGUIName

LocalizedString getLocalizedGUIName()

Returns the set of (localized) gui names of this object.

Returns:

the description as a LocalizedString

setGUIName

void setGUIName(String g,
                Locale locale)

Sets the GUI name of this object.

Parameters:

locale - The locale for which this is valid, or null for the default locale.

g - the description as a String

setGUIName

void setGUIName(String g)

Sets the GUI name of this object for the default locale.

Parameters:

g - the description as a String

getLocalizedDescription

LocalizedString getLocalizedDescription()

Returns the set of (localized) descriptions of this object.

Returns:

the description as a LocalizedString

getDescription

String getDescription(Locale locale)

Returns the description of this object.

Parameters:

locale - The locale for which this must be returned, or null for a default locale. If no fitting description for the given locale is available, getName() can be returned.

Returns:

the description as a String

getDescription

String getDescription()

Returns the description of this object for the default locale.

Returns:

the description as a String

setDescription

void setDescription(String description,
                    Locale locale)

Sets the description of this object.

Parameters:

description - the description as a String

locale - The locale for which this is valid, or null for a default locale.

setDescription

void setDescription(String description)

Sets the description of this object for the default locale.

Parameters:

description - the description as a String