1 /*
2 * Copyright (c) 2002-2020, 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 /*
36 * IDocumentListPortletDAO.java
37 *
38 * Created on 10 octobre 2006, 15:40
39 *
40 * To change this template, choose Tools | Template Manager
41 * and open the template in the editor.
42 */
43 package fr.paris.lutece.plugins.document.business.portlet;
44
45 import fr.paris.lutece.portal.business.portlet.IPortletInterfaceDAO;
46 import fr.paris.lutece.portal.business.portlet.Portlet;
47 import fr.paris.lutece.util.ReferenceItem;
48
49 import java.util.Collection;
50
51
52 /**
53 *
54 */
55 public interface IDocumentListPortletDAO extends IPortletInterfaceDAO
56 {
57 /**
58 * Deletes records for a portlet identifier in the tables portlet_articles_list, published_article_portlet,
59 * auto_publishing
60 *
61 *
62 * @param nPortletId the portlet identifier
63 */
64 void delete( int nPortletId );
65
66 /**
67 * Insert a new record in the table portlet_articles_list
68 *
69 *
70 * @param portlet the instance of the Portlet object to insert
71 */
72 void insert( Portlet portlet );
73
74 /**
75 * Loads the data of Document List Portlet whose identifier is specified in parameter
76 *
77 *
78 * @param nPortletId The Portlet identifier
79 * @return theDocumentListPortlet object
80 */
81 Portlet load( int nPortletId );
82
83 /**
84 * Load the list of documentTypes
85 * @param nDocumentId the document ID
86 * @param strCodeDocumentType The code
87 * @param pOrder order of the portlets
88 * @param pFilter The portlet filter
89 * @return The Collection of the ReferenceItem
90 */
91 Collection<ReferenceItem> selectByDocumentIdAndDocumentType( int nDocumentId, String strCodeDocumentType,
92 PortletOrder pOrder, PortletFilter pFilter );
93
94 /**
95 * Update the record in the table
96 *
97 *
98 * @param portlet A portlet
99 */
100 void store( Portlet portlet );
101
102 /**
103 * Tests if is a portlet is portlet type alias
104 *
105 * @param nPortletId The identifier of the document
106 * @return true if the portlet is alias, false otherwise
107 */
108 boolean checkIsAliasPortlet( int nPortletId );
109 }