1 /*
2 * Copyright (c) 2002-2018, 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.directory.modules.multiview.service;
35
36 import java.util.List;
37
38 import fr.paris.lutece.plugins.directory.modules.multiview.business.record.column.IRecordColumn;
39 import fr.paris.lutece.plugins.directory.modules.multiview.business.record.filter.IRecordFilter;
40 import fr.paris.lutece.plugins.directory.modules.multiview.business.record.panel.IRecordPanel;
41 import fr.paris.lutece.plugins.directory.modules.multiview.web.record.panel.display.IRecordPanelDisplay;
42 import javax.servlet.http.HttpServletRequest;
43
44 /**
45 * Interface of the service for the module-directory-multiview
46 */
47 public interface IDirectoryMultiviewService
48 {
49 // Constants
50 String BEAN_NAME = "directory-multiview.directoryMultiviewService";
51
52 /**
53 * Populate the given RecordPanel with the information from the given list of RecordColumns and RecordFilters
54 *
55 * @param recordPanel
56 * The RecordPanel used to retrieve the values of the RecordColumns
57 * @param listRecordColumn
58 * The list of all RecordColumn to use to be populated
59 * @param listRecordFilter
60 * The list of RecordFilter to use for retrieving the data of the columns to populate
61 */
62 void populateRecordColumns( IRecordPanel recordPanel, List<IRecordColumn> listRecordColumn, List<IRecordFilter> listRecordFilter );
63
64 /**
65 * Find the RecordPanel which is active in the given list
66 *
67 * @param listRecordPanelDisplay
68 * The list to retrieve the active AbstractRecordPanelDisplay
69 * @return the IRecordFilterPanelDisplay which is active or null if not found
70 */
71 IRecordPanelDisplay findActiveRecordPanel( List<IRecordPanelDisplay> listRecordPanelDisplay );
72
73 /**
74 * Filter by authorized directory
75 *
76 * @param recordPanel
77 * @param request
78 */
79 void filterByAuthorizedDirectory( IRecordPanel recordPanel, HttpServletRequest request );
80 }