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.web.record.panel.display;
35
36 import java.util.List;
37 import java.util.Locale;
38
39 import fr.paris.lutece.plugins.directory.modules.multiview.business.record.DirectoryRecordItem;
40 import fr.paris.lutece.plugins.directory.modules.multiview.business.record.panel.IRecordPanel;
41 import fr.paris.lutece.plugins.directory.modules.multiview.web.record.util.IRecordListPosition;
42
43 /**
44 * Interface for Filter of a RecordPanelDisplay
45 */
46 public interface IRecordPanelDisplay extends IRecordListPosition
47 {
48 /**
49 * Return the boolean which tell if the PanelDisplay is for the active Panel or not
50 *
51 * @return the boolean which tell if the PanelDisplay is for the active Panel or not
52 */
53 boolean isActive( );
54
55 /**
56 * Set the boolean which tell if the PanelDisplay is for the active Panel or not
57 *
58 * @param bActive
59 * The boolean which tell if the PanelDisplay is for the active Panel or not
60 */
61 void setActive( boolean bActive );
62
63 /**
64 * Return the technical code of the RecordPanel
65 *
66 * @return the technical code of the RecordPanel
67 */
68 String getTechnicalCode( );
69
70 /**
71 * Return the record number of the RecordPanelDisplay
72 *
73 * @return the record number of the RecordPanelDisplay
74 */
75 int getRecordNumber( );
76
77 /**
78 * Return the template of the RecordPanelDisplay
79 *
80 * @return the template of the RecordPanelDisplay
81 */
82 String getTemplate( );
83
84 /**
85 * Return the recordPanel of the RecordPanelDisplay
86 *
87 * @return the recordPanel
88 */
89 IRecordPanel getRecordPanel( );
90
91 /**
92 * Set the RecordPanel of the RecordPanelDisplay
93 *
94 * @param recordPanel
95 * The RecordPanel of the RecordPanelDisplay
96 */
97 void setRecordPanel( IRecordPanel recordPanel );
98
99 /**
100 * Return the list of DirectoryRecordItem of the RecordPanelDisplay
101 *
102 * @return the list of DirectoryRecordItem of the RecordPanelDisplay
103 */
104 List<DirectoryRecordItem> getDirectoryRecordItemList( );
105
106 /**
107 * Build the template of the RecordPanelDisplay
108 *
109 * @param locale
110 * The locale used to build the template
111 * @return the built template of the RecordPanelDisplay
112 */
113 String buildTemplate( Locale locale );
114 }