1 /*
2 * Copyright (c) 2002-2023, 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.document.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.util.ReferenceItem;
47
48 import java.util.Collection;
49
50 /**
51 *
52 */
53 public interface IDocumentListPortletDAO extends IPortletInterfaceDAO
54 {
55 /**
56 * Deletes records for a portlet identifier in the tables portlet_articles_list, published_article_portlet, auto_publishing
57 *
58 *
59 * @param nPortletId
60 * the portlet identifier
61 */
62 void delete( int nPortletId );
63
64 /**
65 * Insert a new record in the table portlet_articles_list
66 *
67 *
68 * @param portlet
69 * the instance of the Portlet object to insert
70 */
71 void insert( Portlet portlet );
72
73 /**
74 * Loads the data of Document List Portlet whose identifier is specified in parameter
75 *
76 *
77 * @param nPortletId
78 * The Portlet identifier
79 * @return theDocumentListPortlet object
80 */
81 Portlet load( int nPortletId );
82
83 /**
84 * Load the list of documentTypes
85 *
86 * @param nDocumentId
87 * the document ID
88 * @param strCodeDocumentType
89 * The code
90 * @param pOrder
91 * order of the portlets
92 * @param pFilter
93 * The portlet filter
94 * @return The Collection of the ReferenceItem
95 */
96 Collection<ReferenceItem> selectByDocumentIdAndDocumentType( int nDocumentId, String strCodeDocumentType, PortletOrder pOrder, PortletFilter pFilter );
97
98 /**
99 * Update the record in the table
100 *
101 *
102 * @param portlet
103 * A portlet
104 */
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 }