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