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.portal.service.panel;
35
36 import java.util.Locale;
37
38 import javax.servlet.http.HttpServletRequest;
39
40 /**
41 * Interface SEO Panel
42 */
43 public interface LutecePanel
44 {
45 /**
46 * Returns the panel's title
47 *
48 * @return The title
49 */
50 String getPanelKey( );
51
52 /**
53 * Returns the panel's title
54 *
55 * @return The title
56 */
57 String getPanelTitle( );
58
59 /**
60 * Returns the panel's content
61 *
62 * @return The content
63 */
64 String getPanelContent( );
65
66 /**
67 * Returns the panel's order
68 *
69 * @return The order
70 */
71 int getPanelOrder( );
72
73 /**
74 * Sets the panel's locale
75 *
76 * @param locale
77 * The locale
78 */
79 void setPanelLocale( Locale locale );
80
81 /**
82 * Gets the locale
83 *
84 * @return The locale
85 */
86 Locale getPanelLocale( );
87
88 /**
89 * Sets the request
90 *
91 * @param request
92 * The request
93 */
94 void setRequest( HttpServletRequest request );
95
96 /**
97 * Gets the request
98 *
99 * @return The request
100 */
101 HttpServletRequest getRequest( );
102
103 /**
104 * Gets the panel index
105 *
106 * @return The index
107 */
108 int getPanelIndex( );
109 }