View Javadoc
1   /*
2    * Copyright (c) 2002-2014, Mairie de 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.childpages.business.portlet;
35  
36  import java.util.ArrayList;
37  import java.util.List;
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.ReferenceList;
44  
45  
46  /**
47   * This class provides instances management methods for ChildPagesPortlet objects
48   */
49  public class ChildPagesPortletHome extends PortletHome
50  {
51      // Static variable pointed at the DAO instance
52      private static IChildPagesPortletDAO./../../fr/paris/lutece/plugins/childpages/business/portlet/IChildPagesPortletDAO.html#IChildPagesPortletDAO">IChildPagesPortletDAO _dao = (IChildPagesPortletDAO) SpringContextService.getPluginBean( "childpages",
53              "childPagesPortletDAO" );
54  
55      /** This class implements the Singleton design pattern. */
56      private static ChildPagesPortletHome _singleton = null;
57  
58      /**
59       * Constructor
60       */
61      public ChildPagesPortletHome(  )
62      {
63          if ( _singleton == null )
64          {
65              _singleton = this;
66          }
67      }
68  
69      /**
70       * Returns the identifier of the child pages portlet type
71       *
72       * @return the portlet type identifier
73       */
74      public String getPortletTypeId(  )
75      {
76          String strCurrentClassName = this.getClass(  ).getName(  );
77          String strPortletTypeId = PortletTypeHome.getPortletTypeId( strCurrentClassName );
78  
79          return strPortletTypeId;
80      }
81  
82      /**
83       * Returns the instance of ChildPagesPortletHome
84       *
85       * @return the ChildPagesPortletHome instance
86       */
87      public static PortletHome getInstance(  )
88      {
89          if ( _singleton == null )
90          {
91              _singleton = new ChildPagesPortletHome(  );
92          }
93  
94          return _singleton;
95      }
96  
97      /**
98       * Returns the instance of the ChildPagesPortletDAO singleton
99       *
100      * @return the instance of the ChildPagesPortletDAO
101      */
102     public IPortletInterfaceDAO getDAO(  )
103     {
104         return _dao;
105     }
106 
107     /**
108      * Returns the portlet parent page identifier of the portlet whose identifier is specified in parameter
109      *
110      * @param nPortletId the identifier of the portlet
111      * @return the identifier of the parent page portlet
112      */
113     public static int getParentPageId( int nPortletId )
114     {
115         ChildPagesPortlet../../../fr/paris/lutece/plugins/childpages/business/portlet/ChildPagesPortlet.html#ChildPagesPortlet">ChildPagesPortlet portlet = (ChildPagesPortlet) _dao.load( nPortletId );
116 
117         return portlet.getParentPageId(  );
118     }
119 
120     /**
121      * Returns the list of all the pages of the database
122      *
123      * @return the list in form of a ReferenceList object
124      */
125     public static ReferenceList getPagesList(  )
126     {
127         return _dao.selectPagesList(  );
128     }
129 
130     /**
131      * Returns the list of the child pages of a page whose identifier is specified in parameter
132      *
133      * @param nPageId the identifier of the page
134      * @return the list in form of a ReferenceList object
135      */
136     public static ReferenceList getChildPagesList( int nPageId )
137     {
138         return _dao.selectChildPagesList( nPageId );
139     }
140     
141     /**
142      * Returns the list of ChildPages portlets whose parent page id is specified
143      * 
144      * @param parentPageId the parent page id
145      * @return list of ChildPages portlets whose parent page id is parentPageId
146      */
147     public static List<ChildPagesPortlet> getChildPagesPortlets( int parentPageId )
148     {
149         List<ChildPagesPortlet> portlets = _dao.getChildPagesPortlets( parentPageId );
150         List<ChildPagesPortlet> res = new ArrayList<ChildPagesPortlet>( portlets.size( ) );
151         for ( ChildPagesPortlet aPortlet : portlets)
152         {
153             res.add( ( ChildPagesPortlet ) findByPrimaryKey( aPortlet.getId( ) ) );
154         }
155         return res;
156     }
157 }