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.message;
35  
36  import fr.paris.lutece.portal.service.plugin.Plugin;
37  
38  /**
39   * Form Message DAO Interface
40   * 
41   * @author Laurent Payen
42   */
43  public interface IFormMessageDAO
44  {
45  
46      /**
47       * The name of the bean of the DAO
48       */
49      static String BEAN_NAME = "appointment.formMessageDAO";
50  
51      /**
52       * Create a form message
53       * 
54       * @param formMessage
55       *            The instance of the form message to create
56       * @param plugin
57       *            The plugin
58       */
59      void insert( FormMessage formMessage, Plugin plugin );
60  
61      /**
62       * Update a form message
63       * 
64       * @param formMessage
65       *            The form message to update
66       * @param plugin
67       *            The plugin
68       */
69      void update( FormMessage formMessage, Plugin plugin );
70  
71      /**
72       * Remove a form message from its primary key
73       * 
74       * @param nAppointmentFormId
75       *            The id of the form
76       * @param plugin
77       *            The plugin
78       */
79      void delete( int nAppointmentFormId, Plugin plugin );
80  
81      /**
82       * Get a form message from its primary key
83       * 
84       * @param nIdFormMessage
85       *            The id of the form message
86       * @param plugin
87       *            The plugin
88       * @return The form message, or null if no form message has the given primary key
89       */
90      FormMessage select( int nIdFormMessage, Plugin plugin );
91  
92      /**
93       * Returns the formMessage of the form given
94       * 
95       * @param nIdForm
96       *            the form id
97       * @param plugin
98       *            the plugin
99       * @return the formMessage of the form
100      */
101     FormMessage findByIdForm( int nIdForm, Plugin plugin );
102 
103 }