1 /**
2 * This file Copyright (c) 2020 Magnolia International
3 * Ltd. (http://www.magnolia-cms.com). All rights reserved.
4 *
5 *
6 * This file is dual-licensed under both the Magnolia
7 * Network Agreement and the GNU General Public License.
8 * You may elect to use one or the other of these licenses.
9 *
10 * This file is distributed in the hope that it will be
11 * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12 * implied warranty of MERCHANTABILITY or FITNESS FOR A
13 * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14 * Redistribution, except as permitted by whichever of the GPL
15 * or MNA you select, is prohibited.
16 *
17 * 1. For the GPL license (GPL), you can redistribute and/or
18 * modify this file under the terms of the GNU General
19 * Public License, Version 3, as published by the Free Software
20 * Foundation. You should have received a copy of the GNU
21 * General Public License, Version 3 along with this program;
22 * if not, write to the Free Software Foundation, Inc., 51
23 * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24 *
25 * 2. For the Magnolia Network Agreement (MNA), this file
26 * and the accompanying materials are made available under the
27 * terms of the MNA which accompanies this distribution, and
28 * is available at http://www.magnolia-cms.com/mna.html
29 *
30 * Any modifications to this file must keep this entire header
31 * intact.
32 *
33 */
34 package info.magnolia.ui.field;
35
36 import info.magnolia.i18nsystem.I18nText;
37
38 import java.util.List;
39
40 import com.vaadin.data.Converter;
41
42 /**
43 * Value Bound Property defines traits of a property that can have a value.
44 *
45 * @param <T>
46 * The type of value of the property.
47 */
48 public interface ValueBoundProperty<T> {
49 /**
50 * Makes the field mandatory.
51 */
52 boolean isRequired();
53
54 /**
55 * Error message text displayed in case of required = true.
56 */
57 @I18nText
58 String getRequiredErrorMessage();
59
60 /**
61 * The type of this field, i.e. the model type. This needs to be the fully qualified Java class name representing
62 * the type, e.g. java.lang.Long or my.custom.Foo
63 */
64 Class<?> getType();
65
66 /**
67 * Pre-filled value displayed in the field. The value can be overwritten by the user.
68 */
69 T getDefaultValue();
70
71 /**
72 * Determines if a Field Property can be changed.
73 */
74 boolean isReadOnly();
75
76 List<FieldValidatorDefinition> getValidators();
77
78 /**
79 * Converts the model type returned by {@link #getType()} into a presentation type, in case the two differ.
80 * For instance, a text field will likely use String but the model may be a Long. The converter will then handle
81 * the conversion between those two types
82 *
83 * @see #getType
84 * @see Converter
85 */
86 Class<? extends Converter<T, ?>> getConverterClass();
87
88 /**
89 * Message text displayed in case of conversion error.
90 */
91 @I18nText
92 String getConversionErrorMessage();
93 }