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.plugins.dbpage.business.section;
35
36 import java.util.List;
37 import java.util.Map;
38
39 import javax.servlet.http.HttpServletRequest;
40
41
42 /**
43 * An interface describing the sections
44 */
45 public interface IDbPageSection
46 {
47 /**
48 * The identifier of the type of a section
49 * @return The type of the section
50 */
51 long getIdType( );
52
53 /**
54 * The description of the type of the section
55 * @return The description of the section
56 */
57 String getTypeDescription( );
58
59 /**
60 * The html content of the section
61 * @param listValues The list of values
62 * @param request The http request
63 * @return The html rendering of the section
64 */
65 String getHtmlSection( List<String> listValues, HttpServletRequest request );
66
67 /**
68 * The path for the creation of the section
69 * @return The path of the template needed to create the section
70 */
71 String getCreationTemplate( );
72
73 /**
74 * The path for the modification of the section
75 * @return The path of the template needed to modify the section
76 */
77 String getModificationTemplate( );
78
79 /**
80 * A map with additional parameters
81 * @return An additional map with markers and corresponding objects
82 */
83 Map<String, Object> getMarkMap( );
84 }