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 fr.paris.lutece.util.ReferenceList;
37
38 import java.util.List;
39 import java.util.Locale;
40
41 /**
42 * IPortletTypeDAO Interface
43 *
44 */
45 public interface IPortletTypeDAO
46 {
47 /**
48 * Insert a new record in the table PortletType
49 *
50 * @param portletType
51 * The portlet Type object
52 */
53 void insert( PortletType portletType );
54
55 /**
56 * Load the data of PortletType from the table
57 *
58 * @param strPortletTypeId
59 * The identifier of PortletType
60 * @return The instance of the PortletType
61 */
62 PortletType load( String strPortletTypeId );
63
64 /**
65 * Delete a record from the table
66 *
67 * @param strPortletTypeId
68 * The POrtletTYpe identifier
69 */
70 void delete( String strPortletTypeId );
71
72 /**
73 * Returns the portlet type identifier
74 *
75 * @param strPluginHomeClass
76 * the name of the portlet type
77 * @return the identifier of the portlet type
78 */
79 String selectPortletTypeId( String strPluginHomeClass );
80
81 /**
82 * Returns the portlet count for a given provider
83 *
84 * @param strPortletTypeId
85 * The provider's identifier
86 * @return nCount
87 */
88 int selectNbPortletTypeByPortlet( String strPortletTypeId );
89
90 /**
91 * Return a Reference List of portletType
92 *
93 * @param locale
94 * The locale
95 * @return list The reference List
96 */
97 ReferenceList selectPortletsTypesList( Locale locale );
98
99 /**
100 * Returns the list of the portlet types
101 *
102 * @return the list of the portlet types
103 */
104 List<PortletType> selectPortletTypesList( );
105 }