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.plugins.forms.web.entrytype;
35
36 import fr.paris.lutece.plugins.forms.business.form.column.IFormColumn;
37 import fr.paris.lutece.plugins.forms.util.FormsConstants;
38
39 import java.util.ArrayList;
40 import java.util.List;
41 import java.util.Locale;
42 import java.util.Map;
43
44 import javax.servlet.http.HttpServletRequest;
45
46 import org.apache.commons.collections.MapUtils;
47
48 import fr.paris.lutece.plugins.genericattributes.business.Entry;
49 import fr.paris.lutece.plugins.genericattributes.business.Response;
50 import fr.paris.lutece.portal.service.util.AppLogService;
51
52 /**
53 * Interface for the entry display services
54 */
55 public interface IEntryDisplayService
56 {
57 /**
58 * @return the display service name
59 */
60 String getDisplayServiceName( );
61
62 /**
63 * Get the Html of the given step
64 *
65 * @param request
66 * the request
67 * @param entry
68 * The given entry
69 * @param locale
70 * The given locale
71 * @param model
72 * The given model
73 * @param displayType
74 * the display type
75 * @return the template Html of the given entry
76 */
77 String getEntryTemplateDisplay( HttpServletRequest request, Entry entry, Locale locale, Map<String, Object> model, DisplayType displayType );
78
79 /**
80 * Get the column of the entry display service
81 *
82 * @param nFormColumnPosition
83 * @param strColumnTitle
84 * @return the column corresponding the the current entryDisplayService
85 */
86 IFormColumn getFormColumn( int nFormColumnPosition, String strColumnTitle );
87
88 /**
89 * Return from the given map the list of Response of the model
90 *
91 * @param model
92 * The model on which to retrieve the list of all Response
93 * @return the list of Response form the given model or an empty collection if its missing or if an error occurred
94 */
95 @SuppressWarnings( "unchecked" )
96 default List<Response> retrieveResponseListFromModel( Map<String, Object> model )
97 {
98 List<Response> listResponse = new ArrayList<>( );
99
100 if ( !MapUtils.isEmpty( model ) && model.containsKey( FormsConstants.MARK_QUESTION_LIST_RESPONSES ) )
101 {
102 try
103 {
104 listResponse = (List<Response>) model.get( FormsConstants.MARK_QUESTION_LIST_RESPONSES );
105 }
106 catch( ClassCastException exception )
107 {
108 AppLogService.error( "The object associated to the list of Responses doesn't have the good format !" );
109
110 // Erase the value to avoid future errors
111 model.put( FormsConstants.MARK_QUESTION_LIST_RESPONSES, new ArrayList<>( ) );
112 }
113 }
114
115 return listResponse;
116 }
117 }