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