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.portal.business.portlet;
35  
36  import fr.paris.lutece.util.ReferenceList;
37  
38  
39  /**
40   * @author lenaini
41   *
42   */
43  public interface IAliasPortletDAO extends IPortletInterfaceDAO
44  {
45      /**
46       * Insert a new record in the table. NB : The portlet identifier will already been obtained by the portlet girl
47       *
48       * @param portlet the portlet to insert in the database
49       */
50      void insert( Portlet portlet );
51  
52      /**
53       * Delete a record from the table
54       *
55       * @param nPortletId the identifier of the portlet to be deleted
56       */
57      void delete( int nPortletId );
58  
59      /**
60       * Load the data of a portlet from the database
61       *
62       * @param nPortletId the portlet identifier
63       * @return the object Portlet initialized with the data of the database
64       */
65      Portlet load( int nPortletId );
66  
67      /**
68       * Update the record in the table
69       *
70       * @param portlet the portlet reference
71       */
72      void store( Portlet portlet );
73  
74      /**
75       * Select portlets by type
76       * @param strPortletTypeId The type Id
77       * @return A list of portlets
78       */
79      ReferenceList selectPortletsByTypeList( String strPortletTypeId );
80  
81      /**
82       * Select the Alias Id
83       * @param nIdPortlet The portlet Id
84       * @return  The alias Id
85       */
86      int selectAliasId( int nIdPortlet );
87  
88      /**
89       * Select all portlets that accept alias
90       * @return A reference list
91       */
92      ReferenceList selectAcceptAliasPortletList(  );
93  }