View Javadoc
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.blog.business.portlet;
35  
36  import java.util.Collection;
37  import java.util.Map;
38  
39  import fr.paris.lutece.portal.business.portlet.IPortletInterfaceDAO;
40  import fr.paris.lutece.portal.business.portlet.PortletHome;
41  import fr.paris.lutece.portal.business.portlet.PortletTypeHome;
42  import fr.paris.lutece.portal.service.spring.SpringContextService;
43  import fr.paris.lutece.util.ReferenceItem;
44  
45  /**
46   * This class provides instances management methods for BlogsListPortlet objects
47   */
48  public class BlogListPortletHome extends PortletHome
49  {
50      // ///////////////////////////////////////////////////////////////////////////////
51      // Constants
52      // Static variable pointed at the DAO instance
53      private static IBlogListPortletDAO _dao = SpringContextService.getBean( "blog.blogsListPortletDAO" );
54  
55      /* This class implements the Singleton design pattern. */
56      private static BlogListPortletHome _singleton = null;
57  
58      /**
59       * Constructor
60       */
61      public BlogListPortletHome( )
62      {
63          if ( _singleton == null )
64          {
65              _singleton = this;
66          }
67      }
68  
69      /**
70       * Returns the instance of DocumentListPortletHome
71       *
72       * @return the DocumentListPortletHome instance
73       */
74      public static PortletHome getInstance( )
75      {
76          if ( _singleton == null )
77          {
78              _singleton = new BlogListPortletHome( );
79          }
80  
81          return _singleton;
82      }
83  
84      /**
85       * Returns the identifier of the portlet type
86       *
87       * @return the portlet type identifier
88       */
89      @Override
90      public String getPortletTypeId( )
91      {
92          String strCurrentClassName = this.getClass( ).getName( );
93          return PortletTypeHome.getPortletTypeId( strCurrentClassName );
94      }
95  
96      /**
97       * Returns the instance of the portlet DAO singleton
98       *
99       * @return the instance of the DAO singleton
100      */
101     @Override
102     public IPortletInterfaceDAO getDAO( )
103     {
104         return _dao;
105     }
106 
107     /**
108      * Check whether a portlet is an alias portlet
109      * 
110      * @param nPortletId
111      *            The id of the portlet
112      * @return True if the portlet is an alias portlet, false otherwise
113      */
114     public static boolean checkIsAliasPortlet( int nPortletId )
115     {
116         return _dao.checkIsAliasPortlet( nPortletId );
117     }
118 
119     /**
120      * Load the list of Portlet
121      * 
122      * @param nDocumentId
123      *            the document ID
124      * @param pOrder
125      *            order of the portlets
126      * @param pFilter
127      *            The portlet filter
128      * @return The Collection of the ReferenceItem
129      */
130     public static Collection<ReferenceItem> findByFilter( int nDocumentId, PortletOrder pOrder, PortletFilter pFilter )
131     {
132         return _dao.selectPortletByType( nDocumentId, pOrder, pFilter );
133     }
134 
135     /**
136      * Load the portlet template whose type is specified in parameter
137      * 
138      * @param strPortletType
139      * @return Map template
140      */
141     public static Map<Integer, String> loadPages( String strPortletType )
142     {
143         return _dao.loadPages( strPortletType );
144     }
145 
146     /**
147      * Load the portlet template whose type is specified in parameter
148      *
149      * @return The minimum value of blog document order
150      */
151     public static int getMinDocBlogOrder( )
152     {
153         return _dao.selectMinDocumentBlogOrder( );
154     }
155 }