Interface Refinement
public interface Refinement
A refinement is an encapsulation of a validation scheme for a specific attribute
data type. It can also contain other meta data such as unit information or
formatting hints.
- Author:
- Per-Erik
-
Method Summary
Modifier and TypeMethodDescriptiongetDescription
(Locale locale) Returns the description of this refinement in the given locale.List<? extends RefinementElement>
Returns a list of elements that this refinement has.getID()
Returns the id of this refinement's template.Returns the name of this refinement in the given locale.Serializes this refinement into a string.
-
Method Details
-
getRefinementString
String getRefinementString()Serializes this refinement into a string.- Returns:
- A string representation of this refinement.
-
getElements
List<? extends RefinementElement> getElements()Returns a list of elements that this refinement has.- Returns:
- A list of elements that this refinement has.
-
getID
String getID()Returns the id of this refinement's template.- Returns:
- The id of this refinement's template.
-
getName
Returns the name of this refinement in the given locale. If no name is available in the given local, a default name is returned.- Parameters:
locale
- The locale to return a name in.- Returns:
- The name of this refinement in the given locale.
-
getDescription
Returns the description of this refinement in the given locale. If no description is available in the given local, a default description is returned.- Parameters:
locale
- The locale to return a description in.- Returns:
- the description of this refinement in the given locale.
-