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.business.record.panel;
35
36 import java.util.List;
37
38 import fr.paris.lutece.plugins.directory.modules.multiview.business.record.DirectoryRecordItem;
39 import fr.paris.lutece.plugins.directory.modules.multiview.business.record.panel.configuration.RecordPanelConfiguration;
40
41 /**
42 * Interface for the Panel element
43 */
44 public interface IRecordPanel
45 {
46 /**
47 * Return the RecordPanelConfiguration of the RecordPanel. This configuration contains all informations of the RecordPanel.
48 *
49 * @return the RecordPanelConfiguration of the RecordPanel
50 */
51 RecordPanelConfiguration getRecordPanelConfiguration( );
52
53 /**
54 * Return the title of the panel from the configuration. This is the title which will be display on the table view.
55 *
56 * @return the title of the panel from the configuration
57 */
58 String getTitle( );
59
60 /**
61 * Return the technical code of the panel from the configuration. This code is used as unique identifier for a RecordPanel to manage the case of the
62 * selected RecordPanel.
63 *
64 * @return the technical code of the panel from the configuration
65 */
66 String getTechnicalCode( );
67
68 /**
69 * Return the list of DirectoryRecordItem of the Panel
70 *
71 * @return the list of all DirectoryRecordItem of the Panel
72 */
73 List<DirectoryRecordItem> getDirectoryRecordItemList( );
74
75 /**
76 * Set the list of DirectoryRecordItem
77 *
78 * @param listDirectoryRecordItem
79 * The list of DirectoryRecordItem to set to the Panel
80 */
81 void setDirectoryRecordItemList( List<DirectoryRecordItem> listDirectoryRecordItem );
82 }