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.document.business;
35  
36  import fr.paris.lutece.portal.service.spring.SpringContextService;
37  
38  import java.util.List;
39  
40  
41  /**
42   * This class provides instances management methods (create, find, ...) for DocumentPageTemplate objects
43   */
44  public final class DocumentPageTemplateHome
45  {
46      // Static variable pointed at the DAO instance
47      private static IDocumentPageTemplateDAO _dao = SpringContextService.getBean( "document.documentPageTemplateDAO" );
48  
49      /** Creates a new instance of DocumentPageTemplateHome */
50      private DocumentPageTemplateHome(  )
51      {
52      }
53  
54      /**
55       * Creation of an instance of a document page template
56       *
57       * @param documentPageTemplate template An instance of a page template which contains the informations to store
58       * @return The instance of a page template which has been created with its primary key.
59       */
60      public static DocumentPageTemplate../../fr/paris/lutece/plugins/document/business/DocumentPageTemplate.html#DocumentPageTemplate">DocumentPageTemplate create( DocumentPageTemplate documentPageTemplate )
61      {
62          _dao.insert( documentPageTemplate );
63  
64          return documentPageTemplate;
65      }
66  
67      /**
68       * Update of the page template which is specified
69       *
70       * @param documentPageTemplate The instance of the page template which contains the data to store
71       * @return The instance of the page template which has been updated
72       */
73      public static DocumentPageTemplate../../fr/paris/lutece/plugins/document/business/DocumentPageTemplate.html#DocumentPageTemplate">DocumentPageTemplate update( DocumentPageTemplate documentPageTemplate )
74      {
75          _dao.store( documentPageTemplate );
76  
77          return documentPageTemplate;
78      }
79  
80      /**
81       * Remove the page template whose identifier is specified in parameter
82       *
83       * @param nId The identifier of the page template to remove
84       */
85      public static void remove( int nId )
86      {
87          _dao.delete( nId );
88      }
89  
90      ///////////////////////////////////////////////////////////////////////////
91      // Finders
92  
93      /**
94       * Returns an instance of an page template whose identifier is specified in parameter
95       *
96       * @param nKey The page template primary key
97       * @return an instance of a page template
98       */
99      public static DocumentPageTemplate findByPrimaryKey( int nKey )
100     {
101         return _dao.load( nKey );
102     }
103 
104     /**
105      * Return the list of all the page templates
106      *
107      * @return A collection of page templates objects
108      */
109     public static List<DocumentPageTemplate> getPageTemplatesList(  )
110     {
111         return _dao.selectPageTemplatesList(  );
112     }
113 }