View Javadoc
1   /*
2    * Copyright (c) 2002-2018, 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.appointment.business.form;
35  
36  import java.util.List;
37  
38  import fr.paris.lutece.portal.service.plugin.Plugin;
39  
40  /**
41   * Form DAO Interface
42   * 
43   * @author Laurent Payen
44   *
45   */
46  public interface IFormDAO
47  {
48  
49      /**
50       * The name of the bean of the DAO
51       */
52      static String BEAN_NAME = "appointment.formDAO";
53  
54      /**
55       * 
56       * Insert a new record in the table
57       * 
58       * @param form
59       *            instance of the form object to insert
60       * @param plugin
61       *            the plugin
62       */
63      void insert( Form form, Plugin plugin );
64  
65      /**
66       * Update the record in the table
67       * 
68       * @param form
69       *            the reference of the form
70       * @param plugin
71       *            the plugin
72       */
73      void update( Form form, Plugin plugin );
74  
75      /**
76       * Delete a record from the table
77       * 
78       * @param nIdFrom
79       *            identifier of the form to delete
80       * @param plugin
81       *            the plugin
82       */
83      void delete( int nIdForm, Plugin plugin );
84  
85      /**
86       * Load the data from the table
87       * 
88       * @param nIdForm
89       *            the identifier of the form
90       * @param plugin
91       *            the plugin
92       * @return the instance of the Form
93       */
94      Form select( int nIdForm, Plugin plugin );
95  
96      /**
97       * Get all the forms that are active
98       * 
99       * @param plugin
100      *            the plugin
101      * @return all the active forms
102      */
103     List<Form> findActiveForms( Plugin plugin );
104 
105     /**
106      * Get all the forms that are active on displayed on portlet
107      * 
108      * @param plugin
109      *            the plugin
110      * @return all the active and displayed on portlet forms
111      */
112     List<Form> findActiveAndDisplayedOnPortletForms( Plugin plugin );
113 
114     /**
115      * Get all the forms with a given title
116      * 
117      * @param strTitle
118      *            the Title of the form
119      * @param plugin
120      *            the plugin
121      * @return all the forms with this title
122      */
123     List<Form> findByTitle( String strTitle, Plugin plugin );
124 
125     /**
126      * Get all the forms
127      * 
128      * @param plugin
129      *            the plugin
130      * @return all the forms
131      */
132     List<Form> findAllForms( Plugin plugin );
133 
134 }