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  
38  import fr.paris.lutece.portal.business.portlet.IPortletInterfaceDAO;
39  import fr.paris.lutece.portal.business.portlet.Portlet;
40  import fr.paris.lutece.portal.service.plugin.Plugin;
41  import fr.paris.lutece.util.ReferenceItem;
42  import fr.paris.lutece.util.ReferenceList;
43  
44  /**
45   * IBLOGsPortletDAO Interface
46   */
47  public interface IBlogPortletDAO extends IPortletInterfaceDAO
48  {
49      /**
50       * Delete record from table
51       *
52       * @param nPortletId
53       *            The indentifier of the Portlet
54       */
55      @Override
56      void delete( int nPortletId );
57  
58      /**
59       * Insert a new record in the table.
60       *
61       * @param portlet
62       *            The Instance of the Portlet
63       */
64      @Override
65      void insert( Portlet portlet );
66  
67      /**
68       * load the data of dbpagePortlet from the table
69       *
70       * @param nIdPortlet
71       *            The identifier of the portlet
72       * @return portlet The instance of the object portlet
73       */
74      Portlet load( int nIdPortlet );
75  
76      /**
77       * Update the record in the table
78       *
79       * @param portlet
80       *            The reference of the portlet
81       */
82      @Override
83      void store( Portlet portlet );
84  
85      /**
86       * 
87       * @param plugin
88       * @return
89       */
90      ReferenceList selectBlogPortletReferenceList( Plugin plugin );
91  
92      /**
93       * Load the list of portlet
94       * 
95       * @param nDocumentId
96       *            the document ID
97       * @param pOrder
98       *            order of the portlets
99       * @param pFilter
100      *            the filter
101      * @return The Collection of the ReferenceItem
102      */
103 
104     Collection<ReferenceItem> selectPortletByType( int nDocumentId, PortletOrder pOrder, PortletFilter pFilter );
105 
106 }