View Javadoc
1   /*
2    * Copyright (c) 2002-2022, 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.portal.business.style;
35  
36  import fr.paris.lutece.portal.business.stylesheet.StyleSheet;
37  import fr.paris.lutece.util.ReferenceList;
38  
39  import java.util.Collection;
40  
41  /**
42   *
43   * @author LEVY
44   */
45  public interface IStyleDAO
46  {
47      /**
48       * Checks if a style has been created in the database with the given portal componenet
49       *
50       * @param nPortalComponentId
51       *            The identifier of the portal component
52       * @return true if a style has been created for this portal component, false otherwise
53       */
54      boolean checkStylePortalComponent( int nPortalComponentId );
55  
56      /**
57       * Delete a record from the table
58       *
59       * @param nStyleId
60       *            the identifier of the style to delete
61       */
62      void delete( int nStyleId );
63  
64      /**
65       * Insert a new record in the table.
66       *
67       * @param style
68       *            The Instance of the object Style
69       */
70      void insert( Style style );
71  
72      /**
73       * load the data of the Style whose identifier is specified in parameter from the table
74       *
75       * @param nStyleId
76       *            The identifier of the Style
77       * @return an instance of the Style which has been created
78       */
79      Style load( int nStyleId );
80  
81      /**
82       * Returns the list of the portal component in form of a ReferenceList
83       *
84       * @return the list of the portal component
85       */
86      ReferenceList selectPortalComponentList( );
87  
88      /**
89       * load the data of the StyleSheet which re associated to the given style
90       *
91       *
92       * @param nStyleId
93       *            The identifier of the Style
94       * @return an instance of the Style which has been created
95       */
96      Collection<StyleSheet> selectStyleSheetList( int nStyleId );
97  
98      /**
99       * Load the list of styles stored in the database
100      *
101      * @return The styles list in form of a Collection object
102      */
103     Collection<Style> selectStylesList( );
104 
105     /**
106      * Update the record in the table
107      *
108      * @param style
109      *            The instance of the Style to update
110      */
111     void store( Style style );
112 }