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.breadcrumb;
35
36 import java.util.HashMap;
37 import java.util.Map;
38
39 import javax.servlet.http.HttpServletRequest;
40
41 import fr.paris.lutece.plugins.forms.web.FormResponseManager;
42
43 /**
44 * Interface for the entry data services
45 */
46 public interface IBreadcrumb
47 {
48 /**
49 * Gives the bean name of the breadcrumb
50 *
51 * @return the Breadcrumb bean name
52 */
53 String getBreadcrumbBeanName( );
54
55 /**
56 * Gives the display name of the breadcrumb
57 *
58 * @return the Breadcrumb display name
59 */
60 String getBreadcrumbDisplayName( );
61
62 /**
63 * Gives the HTML displayed before the current step
64 *
65 * @param request
66 * the request
67 * @param formResponseManager
68 * the object that contains the actual visited list of step
69 * @return the HTML displayed before the current step
70 */
71 String getTopHtml( HttpServletRequest request, FormResponseManager formResponseManager );
72
73 /**
74 * Gives the model to use for the current step
75 *
76 * @param request
77 * the request
78 * @param formResponseManager
79 * the form response manager
80 * @return the model
81 */
82 default Map<String, Object> getModelForCurrentStep( HttpServletRequest request, FormResponseManager formResponseManager )
83 {
84 return new HashMap<>( );
85 }
86
87 /**
88 * Gives the HTML displayed after the current step
89 *
90 * @param request
91 * the request
92 * @param formResponseManager
93 * the object that contains the actual visited list of step
94 * @return the HTML displayed after the current step
95 */
96 String getBottomHtml( HttpServletRequest request, FormResponseManager formResponseManager );
97 }