1 /*
2 * Copyright (c) 2002-2021, 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 /*
35 * IDocumentListPortletDAO.java
36 *
37 * Created on 10 octobre 2006, 15:40
38 *
39 * To change this template, choose Tools | Template Manager
40 * and open the template in the editor.
41 */
42 package fr.paris.lutece.plugins.blog.business.portlet;
43
44 import fr.paris.lutece.portal.business.portlet.IPortletInterfaceDAO;
45 import fr.paris.lutece.portal.business.portlet.Portlet;
46 import fr.paris.lutece.portal.service.plugin.Plugin;
47 import fr.paris.lutece.util.ReferenceItem;
48 import fr.paris.lutece.util.ReferenceList;
49
50 import java.util.Collection;
51 import java.util.Map;
52
53 /**
54 *
55 */
56 public interface IBlogListPortletDAO extends IPortletInterfaceDAO
57 {
58 /**
59 * Deletes records for a portlet identifier in the tables Blogs_list_portlet
60 *
61 *
62 * @param nPortletId
63 * the portlet identifier
64 */
65 @Override
66 void delete( int nPortletId );
67
68 /**
69 * Insert a new record in the table Blogs_list_portlet
70 *
71 *
72 * @param portlet
73 * the instance of the Portlet object to insert
74 */
75 @Override
76 void insert( Portlet portlet );
77
78 /**
79 * Loads the data of Document List Portlet whose identifier is specified in parameter
80 *
81 *
82 * @param nPortletId
83 * The Portlet identifier
84 * @return theDocumentListPortlet object
85 */
86 @Override
87 Portlet load( int nPortletId );
88
89 /**
90 * Load the portlet template whose type is specified in parameter
91 *
92 * @param strPortletType
93 * @return Map template
94 */
95 Map<Integer, String> loadPages( String strPortletType );
96
97 /**
98 * Update the record in the table
99 *
100 *
101 * @param portlet
102 * A portlet
103 */
104 @Override
105 void store( Portlet portlet );
106
107 /**
108 * Tests if is a portlet is portlet type alias
109 *
110 * @param nPortletId
111 * The identifier of the document
112 * @return true if the portlet is alias, false otherwise
113 */
114 boolean checkIsAliasPortlet( int nPortletId );
115
116 /**
117 *
118 * @param plugin
119 * @return
120 */
121 ReferenceList selectBlogListPortletReferenceList( Plugin plugin );
122
123 /**
124 * Load the list of portlet
125 *
126 * @param nDocumentId
127 * the document ID
128 * @param pOrder
129 * order of the portlets
130 * @param pFilter
131 * @return The Collection of the ReferenceItem
132 */
133
134 Collection<ReferenceItem> selectPortletByType( int nDocumentId, PortletOrder pOrder, PortletFilter pFilter );
135
136 /**
137 * Get the min of document blog order
138 *
139 * @return The minimum order from blog list portlet
140 */
141 int selectMinDocumentBlogOrder( );
142 }