View Javadoc
1   /*
2    * Copyright (c) 2002-2022, City of Paris
3    * All rights reserved.
4    *
5    * Redistribution and use in source and binary forms, with or without
6    * modification, are permitted provided that the following conditions
7    * are met:
8    *
9    *  1. Redistributions of source code must retain the above copyright notice
10   *     and the following disclaimer.
11   *
12   *  2. Redistributions in binary form must reproduce the above copyright notice
13   *     and the following disclaimer in the documentation and/or other materials
14   *     provided with the distribution.
15   *
16   *  3. Neither the name of 'Mairie de Paris' nor 'Lutece' nor the names of its
17   *     contributors may be used to endorse or promote products derived from
18   *     this software without specific prior written permission.
19   *
20   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21   * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22   * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23   * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
24   * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25   * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26   * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27   * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28   * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29   * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30   * POSSIBILITY OF SUCH DAMAGE.
31   *
32   * License 1.0
33   */
34  package fr.paris.lutece.util.beanvalidation;
35  
36  /**
37   * Interface for ValidationError Configs
38   */
39  public interface ValidationErrorConfig
40  {
41      /**
42       * Returns the list of constraint descriptor attribute that will appear in the value#1 of the message
43       * 
44       * @return A list of attributes separated with spaces or commas
45       */
46      String getValue1Attributes( );
47  
48      /**
49       * Returns the list of constraint descriptor attribute that will appear in the value#2 of the message
50       * 
51       * @return A list of attributes separated with spaces or commas
52       */
53      String getValue2Attributes( );
54  
55      /**
56       * The array of all variables prefix
57       * 
58       * @return The array
59       */
60      String [ ] getVariablesPrefix( );
61  
62      /**
63       * The prefix of fields name in the resource file (ex : myplugin.model.entity.product.field." )
64       * 
65       * @return the _strFieldKeysPrefix
66       */
67      String getFieldKeysPrefix( );
68  
69      /**
70       * Returns the begin wrapper string for fieldname rendering (ex : "'" or "<strong">" )
71       * 
72       * @return The begin string
73       */
74      String getFieldWrapperBegin( );
75  
76      /**
77       * Returns the end wrapper string for fieldname rendering (ex : "'" or "</strong">" )
78       * 
79       * @return The end string
80       */
81      String getFieldWrapperEnd( );
82  }