DS-3699 Add comment about the scope of the SelectableMetadata class

This commit is contained in:
Andrea Bollini
2017-11-08 23:14:15 +01:00
parent 216d7481bb
commit e6f68668fd

View File

@@ -12,7 +12,14 @@ import com.fasterxml.jackson.annotation.JsonInclude.Include;
/**
* The SelectableMetadata REST Resource. It is not addressable directly, only
* used as inline object in the InputForm resource
* used as inline object in the InputForm resource.
*
* SelectableMetadata was introduced to make a clear distinction between the
* cases where a value-pairs was used as an authority list of acceptable values
* (dropdown) and where it was used to allow to pick the metadata to use to
* store the value (qualdrop_values). If a value-pair is used by a
* qualdrop_value it is not autoregistered as an authority, instead
* it is exposed as an array of SelectableMetadata object
*
* @author Andrea Bollini (andrea.bollini at 4science.it)
*