1 /*
2 * Copyright (c) 2002-2022, City of 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.portal.business.portlet;
35
36 import java.util.Collection;
37
38 import fr.paris.lutece.util.ReferenceList;
39
40 /**
41 * @author lenaini
42 *
43 */
44 public interface IAliasPortletDAO extends IPortletInterfaceDAO
45 {
46 /**
47 * Insert a new record in the table. NB : The portlet identifier will already been obtained by the portlet girl
48 *
49 * @param portlet
50 * the portlet to insert in the database
51 */
52 void insert( Portlet portlet );
53
54 /**
55 * Delete a record from the table
56 *
57 * @param nPortletId
58 * the identifier of the portlet to be deleted
59 */
60 void delete( int nPortletId );
61
62 /**
63 * Load the data of a portlet from the database
64 *
65 * @param nPortletId
66 * the portlet identifier
67 * @return the object Portlet initialized with the data of the database
68 */
69 Portlet load( int nPortletId );
70
71 /**
72 * Update the record in the table
73 *
74 * @param portlet
75 * the portlet reference
76 */
77 void store( Portlet portlet );
78
79 /**
80 * Select portlets by type
81 *
82 * @param strPortletTypeId
83 * The type Id
84 * @return A list of portlets
85 */
86 ReferenceList selectPortletsByTypeList( String strPortletTypeId );
87
88 /**
89 * Select the Alias Id
90 *
91 * @param nIdPortlet
92 * The portlet Id
93 * @return The alias Id
94 */
95 int selectAliasId( int nIdPortlet );
96
97 /**
98 * Select all portlets that accept alias
99 *
100 * @return A reference list
101 */
102 ReferenceList selectAcceptAliasPortletRefList( );
103
104 /**
105 * Select all portlets that accept alias
106 *
107 * @return A Portlet list
108 */
109 Collection<Portlet> selectAcceptAliasPortletList( );
110 }