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.portal.business.portlet.PortletHome;
38 import fr.paris.lutece.portal.business.portlet.PortletTypeHome;
39 import fr.paris.lutece.portal.service.spring.SpringContextService;
40 import fr.paris.lutece.util.ReferenceItem;
41
42 import java.util.Collection;
43 import java.util.List;
44
45 public class DocumentPortletHome extends PortletHome
46 {
47 /////////////////////////////////////////////////////////////////////////////////
48 // Constants
49 // Static variable pointed at the DAO instance
50 private static IDocumentPortletDAO _dao = SpringContextService.getBean( "document.documentPortletDAO" );
51
52 /* This class implements the Singleton design pattern. */
53 private static DocumentPortletHome _singleton = null;
54
55 /**
56 * Constructor
57 */
58 public DocumentPortletHome( )
59 {
60 if ( _singleton == null )
61 {
62 _singleton = this;
63 }
64 }
65
66 /**
67 * Returns the instance of DocumentPortletHome
68 *
69 * @return the DocumentPortletHome instance
70 */
71 public static PortletHome getInstance( )
72 {
73 if ( _singleton == null )
74 {
75 _singleton = new DocumentPortletHome( );
76 }
77
78 return _singleton;
79 }
80
81 /**
82 * Returns the identifier of the portlet type
83 *
84 * @return the portlet type identifier
85 */
86 public String getPortletTypeId( )
87 {
88 String strCurrentClassName = this.getClass( ).getName( );
89 String strPortletTypeId = PortletTypeHome.getPortletTypeId( strCurrentClassName );
90
91 return strPortletTypeId;
92 }
93
94 /**
95 * Returns the instance of the portlet DAO singleton
96 *
97 * @return the instance of the DAO singleton
98 */
99 public IPortletInterfaceDAO getDAO( )
100 {
101 return _dao;
102 }
103
104 /**
105 * Returns a list of couple id_portlet/name filtered by documentType and category
106 *
107 * @param nDocumentId
108 * the Document ID
109 * @param strCodeDocumentType
110 * the code
111 * @param pOrder
112 * the order of the portlets
113 * @param pFilter
114 * The portlet filter
115 * @return A collection of referenceItem
116 */
117 public static Collection<ReferenceItem> findByCodeDocumentTypeAndCategory( int nDocumentId, String strCodeDocumentType, PortletOrder pOrder,
118 PortletFilter pFilter )
119 {
120 // FIXME : method should access to different home business methods
121 return _dao.selectByDocumentOdAndDocumentType( nDocumentId, strCodeDocumentType, pOrder, pFilter );
122 }
123
124 /**
125 * Check whether a portlet is an alias portlet
126 *
127 * @param nPortletId
128 * The id of the portlet
129 * @return True if the portlet is an alias portlet, false otherwise
130 */
131 public static boolean checkIsAliasPortlet( int nPortletId )
132 {
133 return _dao.checkIsAliasPortlet( nPortletId );
134 }
135
136 /**
137 * Finds all portlets that contains the document
138 *
139 * @param nDocumentId
140 * document id
141 * @return all portlets id.
142 */
143 public static List<Integer> findPortletForDocument( int nDocumentId )
144 {
145 return _dao.selectPortletsByDocumentId( nDocumentId );
146 }
147 }