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.List;
37
38 import fr.paris.lutece.portal.business.portlet.IPortletInterfaceDAO;
39 import fr.paris.lutece.portal.business.portlet.Portlet;
40 import fr.paris.lutece.util.ReferenceList;
41
42
43 /**
44 *
45 * @author nguyenme
46 */
47 public interface IChildPagesPortletDAO extends IPortletInterfaceDAO
48 {
49 /**
50 * Deletes a record from the table
51 *
52 *
53 * @param nPortletId Identifier portlet
54 */
55 public abstract void delete( int nPortletId );
56
57 /**
58 * Insert a new record in the table childpages_portlet
59 *
60 *
61 * @param portlet the instance of the Portlet object to insert
62 */
63 public abstract void insert( Portlet portlet );
64
65 /**
66 * Loads the data of a ChildPagesPortlet whose identifier is specified in parameter from the table
67 *
68 *
69 * @param nPortletId The ChildPagesPortlet identifier
70 * @return the ChildPagesPortlet object
71 */
72 public abstract Portlet load( int nPortletId );
73
74 /**
75 * Load the list of the child pages of a page whose identifier is specified in parameter
76 *
77 *
78 * @param nPageId the identifier of the page
79 * @return the list in form of a ReferenceList object
80 */
81 public abstract ReferenceList selectChildPagesList( int nPageId );
82
83 /**
84 * Load the list of all the pages of the database
85 *
86 *
87 * @return the list in form of a ReferenceList object
88 */
89 public abstract ReferenceList selectPagesList( );
90
91 /**
92 * Updates a record in the table with the Portlet instance specified in parameter
93 *
94 * @param portlet the instance of Portlet class to be updated
95 */
96 public abstract void store( Portlet portlet );
97
98 /**
99 * Returns the list of ChildPages portlets whose parent page id is specified
100 *
101 * @param parentPageId the parent page id
102 * @return list of ChildPages portlets whose parent page id is parentPageId
103 */
104 public List<ChildPagesPortlet> getChildPagesPortlets( int parentPageId );
105 }