Javadoc @HiddenColumn

This commit is contained in:
Francesco 2023-09-30 20:52:34 +02:00
parent 91f59e2f87
commit cd5076303d

View File

@ -6,12 +6,17 @@ import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target; import java.lang.annotation.Target;
/** /**
* Marks a column as hidden. This column and its values will not be shown * <p>Marks a column as hidden. This column and its values will not be shown in the
* in the list and detail view for objects of this type. * list and detail view for objects of this type. If the column is nullable, it
* If the column is nullable, it will be hidden in the create and edit * will be hidden in the create and edit forms as well (and this will result
* forms as well (and this will result in the column having being NULL * in the column always being NULL when creating/editing objects). If, instead,
* when the objects are created/edited). If, instead, it's not a nullable * it's not nullable column, it will be included in the create and edit forms
* column, it will be included in the create and edit forms. * as it would otherwise prevent the creation of items.</p>
*
* <p><strong>Please note that this is not meant as a security feature, </strong> but
* rather to hide uninformative columns that clutter the interface. In fact, since
* the create and edit form come pre-filled with all the information, these views
* <b>will</b> show the value of the hidden column (if it's not nullable).
* *
*/ */
@Retention(RetentionPolicy.RUNTIME) @Retention(RetentionPolicy.RUNTIME)