org.mmbase.bridge
Interface Descriptor

All Known Subinterfaces:
DataType, Field, LengthDataType
All Known Implementing Classes:
AbstractDescriptor, AbstractField, AbstractLengthDataType, BasicDataType, BasicField, CoreField, StringDataType

public interface Descriptor

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

Since:
MMBase-1.8

Method Summary
 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

public String getName()
Returns the name or 'key' of this object, or null if not applicable.

Returns:
the name as a String

getGUIName

public String getGUIName()
Returns the GUI name for this object.

Returns:
the GUI name for this object

getGUIName

public 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

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

Returns:
the description as a LocalizedString

setGUIName

public 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

public void setGUIName(String g)
Sets the GUI name of this object for the default locale.

Parameters:
g - the description as a String

getLocalizedDescription

public LocalizedString getLocalizedDescription()
Returns the set of (localized) descriptions of this object.

Returns:
the description as a LocalizedString

getDescription

public 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

public String getDescription()
Returns the description of this object for the default locale.

Returns:
the description as a String

setDescription

public 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

public void setDescription(String description)
Sets the description of this object for the default locale.

Parameters:
description - the description as a String


MMBase build 1.8.1.20060716