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