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.calendar.business.stylesheet;
35  
36  import fr.paris.lutece.portal.business.stylesheet.StyleSheet;
37  import fr.paris.lutece.portal.service.plugin.Plugin;
38  import fr.paris.lutece.portal.service.spring.SpringContextService;
39  
40  import java.util.Collection;
41  
42  
43  /**
44   * This class provides instances management methods (create, find, ...) for
45   * Stylesheet objects
46   */
47  public final class CalendarStyleSheetHome
48  {
49      // Static variable pointed to the DAO instance
50      private static ICalendarStyleSheetDAO _dao = SpringContextService.getBean( "calendar.calendarStyleSheetDAO" );
51  
52      /**
53       * Creates a new StyleSheetHome object.
54       */
55      private CalendarStyleSheetHome( )
56      {
57      }
58  
59      /**
60       * Creation of an instance of a Stylesheet file in the database
61       * @param stylesheet An instance of a stylesheet which contains the
62       *            informations to store
63       * @param strExtension The extension of files generated with the stylesheet
64       * @param plugin Plugin
65       * @return The instance of the stylesheet which has been created.
66       */
67      public static StyleSheet create( StyleSheet stylesheet, String strExtension, Plugin plugin )
68      {
69          _dao.insert( stylesheet, strExtension, plugin );
70  
71          return stylesheet;
72      }
73  
74      /**
75       * Deletes the StylesSheet whose identifier is specified in parameter
76       * @param nId the identifier of the stylesheet to delete
77       * @param plugin Plugin
78       */
79      public static void remove( int nId, Plugin plugin )
80      {
81          _dao.delete( nId, plugin );
82      }
83  
84      /**
85       * Update the StylesSheet whose identifier is specified in parameter
86       * @param stylesheet the stylesheet to update
87       * @param plugin Plugin
88       */
89      public static void update( StyleSheet stylesheet, Plugin plugin )
90      {
91          _dao.store( stylesheet, plugin );
92      }
93  
94      ///////////////////////////////////////////////////////////////////////////
95      // Finders
96  
97      /**
98       * Returns an instance of a stylesheet file whose identifier is specified in
99       * parameter
100      * @param nKey the stylesheet primary key
101      * @param plugin Plugin
102      * @return the instance of the styleSheet whose identifier is the nKey
103      */
104     public static StyleSheet findByPrimaryKey( int nKey, Plugin plugin )
105     {
106         return _dao.load( nKey, plugin );
107     }
108 
109     /**
110      * Returns a collection of StyleSheet objet
111      * @param plugin Plugin
112      * @return A collection of StyleSheet object
113      */
114     public static Collection<StyleSheet> getStyleSheetList( Plugin plugin )
115     {
116         return _dao.selectStyleSheetList( plugin );
117     }
118 
119     /**
120      * Insertion of the extension of an export file in the database
121      * @param nId The id
122      * @param strExtension the extension file
123      * @param plugin Plugin
124      */
125     public static void insertExtension( int nId, String strExtension, Plugin plugin )
126     {
127         _dao.insertExtension( nId, strExtension, plugin );
128     }
129 
130     /**
131      * Select the extension file related to the export stylesheet
132      * @param nId the identifier of the stylesheet
133      * @param plugin Plugin
134      * @return the extension file
135      */
136     public static String getExtension( int nId, Plugin plugin )
137     {
138         return _dao.selectExtension( nId, plugin );
139     }
140 
141     /**
142      * Update the the extension file whose identifier is specified in parameter
143      * @param nId the stylesheet id
144      * @param strExtension the new extension file
145      * @param plugin Plugin
146      */
147     public static void updateExtension( int nId, String strExtension, Plugin plugin )
148     {
149         _dao.updateExtension( nId, strExtension, plugin );
150     }
151 }