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.column.querypart;
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.column.RecordColumnCell;
40 import fr.paris.lutece.util.sql.DAOUtil;
41
42 /**
43 * Global interface for all record column query part
44 */
45 public interface IRecordColumnQueryPart
46 {
47 /**
48 * Return the select query part for the RecordColumn
49 *
50 * @return the select query part for the RecordColumn
51 */
52 String getRecordColumnSelectQuery( );
53
54 /**
55 * Return the from query part for the RecordColumn
56 *
57 * @return the from query part for the RecordColumn
58 */
59 String getRecordColumnFromQuery( );
60
61 /**
62 * Return the list of join queries for the RecordColumn
63 *
64 * @return the list of join queries for the RecordColumn
65 */
66 List<String> getRecordColumnJoinQueries( );
67
68 /**
69 * Set the record column to the RecordColumnQueryPart
70 *
71 * @param recordColumn
72 * The RecordColumn to set to the RecordColumnQueryPart
73 */
74 void setRecordColumn( IRecordColumn recordColumn );
75
76 /**
77 * Return the RecordColumn of the RecordColumnQueryPart
78 *
79 * @return the RecordColumn of the RecordColumnQueryPart
80 */
81 IRecordColumn getRecordColumn( );
82
83 /**
84 * Return the RecordColumnCell of the RecordColumnQueryPart
85 *
86 * @param daoUtil
87 * The daoUtil to retrieve the values to retrieve to the record column
88 * @return the RecordColumnCell which contains all the values of the record column from the given daoUtil
89 */
90 RecordColumnCell getRecordColumnCell( DAOUtil daoUtil );
91 }