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 java.util.List;
37  
38  
39  /**
40   * Interface for document page template DAO
41   */
42  public interface IDocumentPageTemplateDAO
43  {
44      /**
45       * Delete a record from the table
46       *
47       * @param nPageTemplateId The indentifier of the object DocumentPageTemplate
48       */
49      void delete( int nPageTemplateId );
50  
51      /**
52       * Insert a new record in the table.
53       *
54       * @param documentPageTemplate The Instance of the object DocumentPageTemplate
55       */
56      void insert( DocumentPageTemplate documentPageTemplate );
57  
58      /**
59       * load the data of DocumentPageTemplate from the table
60       *
61       *
62       * @param nPageTemplateId The indentifier of the object PageTemplate
63       * @return The Instance of the object PageTemplate
64       */
65      DocumentPageTemplate load( int nPageTemplateId );
66  
67      /**
68       * Returns a list of all the page templates
69       *
70       * @return A list of PageTemplates objects
71       */
72      List<DocumentPageTemplate> selectPageTemplatesList(  );
73  
74      /**
75       * Update the record in the table
76       *
77       * @param pageTemplate The instance of the PageTemplate to update
78       */
79      void store( DocumentPageTemplate pageTemplate );
80  }