1 /*
2 * Copyright (c) 2002-2014, Mairie de 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 /**
42 * Interface SEO Panel
43 */
44 public interface LutecePanel
45 {
46 /**
47 * Returns the panel's title
48 * @return The title
49 */
50 String getPanelKey( );
51
52 /**
53 * Returns the panel's title
54 * @return The title
55 */
56 String getPanelTitle( );
57
58 /**
59 * Returns the panel's content
60 * @return The content
61 */
62 String getPanelContent( );
63
64 /**
65 * Returns the panel's order
66 * @return The order
67 */
68 int getPanelOrder( );
69
70 /**
71 * Sets the panel's locale
72 * @param locale The locale
73 */
74 void setPanelLocale( Locale locale );
75
76 /**
77 * Gets the locale
78 * @return The locale
79 */
80 Locale getPanelLocale( );
81
82 /**
83 * Sets the request
84 * @param request The request
85 */
86 void setRequest( HttpServletRequest request );
87
88 /**
89 * Gets the request
90 * @return The request
91 */
92 HttpServletRequest getRequest( );
93
94 /**
95 * Gets the panel index
96 * @return The index
97 */
98 int getPanelIndex( );
99 }