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.form.business;
35  
36  import fr.paris.lutece.portal.service.plugin.Plugin;
37  import fr.paris.lutece.util.ReferenceList;
38  
39  /*
40   * Copyright (c) 2002-2014, Mairie de Paris
41   * All rights reserved.
42   *
43   * Redistribution and use in source and binary forms, with or without
44   * modification, are permitted provided that the following conditions
45   * are met:
46   *
47   *  1. Redistributions of source code must retain the above copyright notice
48   *     and the following disclaimer.
49   *
50   *  2. Redistributions in binary form must reproduce the above copyright notice
51   *     and the following disclaimer in the documentation and/or other materials
52   *     provided with the distribution.
53   *
54   *  3. Neither the name of 'Mairie de Paris' nor 'Lutece' nor the names of its
55   *     contributors may be used to endorse or promote products derived from
56   *     this software without specific prior written permission.
57   *
58   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
59   * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
60   * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
61   * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
62   * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
63   * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
64   * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
65   * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
66   * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
67   * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
68   * POSSIBILITY OF SUCH DAMAGE.
69   *
70   * License 1.0
71   */
72  import java.util.List;
73  
74  
75  /**
76  * IFormDAO Interface
77  */
78  public interface IExportFormatDAO
79  {
80      /**
81       * Insert a new record in the table.
82       *
83       * @param exportFormat instance of the ExportFormat object to insert
84       * @param plugin the plugin
85       */
86      void insert( ExportFormat exportFormat, Plugin plugin );
87  
88      /**
89           * Update the exportFormat in the table
90           *
91           * @param exportFormat instance of the ExportFormat object to update
92           * @param plugin the plugin
93           */
94      void store( ExportFormat exportFormat, Plugin plugin );
95  
96      /**
97           * Delete a record from the table
98           *
99           * @param nIdExport The identifier of the ExportFormat
100          * @param plugin the plugin
101          */
102     void delete( int nIdExport, Plugin plugin );
103 
104     ///////////////////////////////////////////////////////////////////////////
105     // Finders
106 
107     /**
108          * Load the data of the export format from the table
109          *
110          * @param nKey The identifier of the export format
111          * @param plugin the plugin
112          * @return the instance of the ExportFormat
113          */
114     ExportFormat load( int nKey, Plugin plugin );
115 
116     /**
117      * Load the data of all the ExportFormat and returns them in form of a list
118      *
119      * @param plugin the plugin
120      * @return The List which contains the data of all the ExportFormat
121      */
122     List<ExportFormat> selectListExport( Plugin plugin );
123 
124     /**
125      * Load the data of all the export format returns them in a  reference list
126      * @param plugin the plugin
127      * @return  a  reference list of export format
128      */
129     ReferenceList getListExport( Plugin plugin );
130 }