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 package fr.paris.lutece.plugins.document.business.portlet;
35
36 import fr.paris.lutece.portal.business.portlet.IPortletInterfaceDAO;
37 import fr.paris.lutece.util.ReferenceItem;
38
39 import java.util.Collection;
40 import java.util.List;
41
42 /**
43 * Interface for document portlet DAO
44 */
45 public interface IDocumentPortletDAO extends IPortletInterfaceDAO
46 {
47 /**
48 * Returns a list of couple id_portlet/name filtered by documentType and category
49 *
50 * @param nDocumentId
51 * the Document ID
52 * @param strCodeDocumentType
53 * the code
54 * @param pOrder
55 * the order of the portlets
56 * @param pFilter
57 * The portlet filter
58 * @return A collection of referenceItem
59 */
60 Collection<ReferenceItem> selectByDocumentOdAndDocumentType( int nDocumentId, String strCodeDocumentType, PortletOrder pOrder, PortletFilter pFilter );
61
62 /**
63 * Tests if is a portlet is portlet type alias
64 *
65 * @param nPortletId
66 * The identifier of the document
67 * @return true if the portlet is alias, false otherwise
68 */
69 boolean checkIsAliasPortlet( int nPortletId );
70
71 /**
72 * Find all portlets that contain the document
73 *
74 * @param nDocumentId
75 * the document id
76 * @return all portlets id that contain the document
77 */
78 List<Integer> selectPortletsByDocumentId( int nDocumentId );
79 }