View Javadoc
1   /*
2    * Copyright (c) 2002-2015, 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  
35  package fr.paris.lutece.plugins.directory.modules.exportfile.business;
36  
37  import fr.paris.lutece.portal.service.plugin.Plugin;
38  
39  import java.util.Collection;
40  
41  /**
42   * IFileNameDAO Interface
43   */
44  public interface IFileNameDAO
45  {
46      /**
47       * Insert a new record in the table.
48       * 
49       * @param fileName
50       *            instance of the fileName object to insert
51       * @param plugin
52       *            the Plugin
53       */
54      void insert( FileName fileName, Plugin plugin );
55  
56      /**
57       * Update the record in the table
58       * 
59       * @param fileName
60       *            the reference of the fileName
61       * @param plugin
62       *            the Plugin
63       */
64      void store( FileName fileName, Plugin plugin );
65  
66      /**
67       * Delete a record from the table
68       * 
69       * @param fileName
70       *            The fileName
71       * @param plugin
72       *            the Plugin
73       */
74      void delete( FileName fileName, Plugin plugin );
75  
76      /**
77       * Delete a record from the table
78       * 
79       * @param nIdMapping
80       *            The nIdMapping
81       * @param plugin
82       *            the Plugin
83       */
84      void delete( int nIdMapping, Plugin plugin );
85  
86      // /////////////////////////////////////////////////////////////////////////
87      // Finders
88  
89      /**
90       * Load the data of all the fileName objects and returns them as a collection
91       * 
92       * @param plugin
93       *            the Plugin
94       * @return The collection which contains the data of all the fileName objects
95       */
96      Collection<FileName> selectFilesNameList( int nMappingEntry, Plugin plugin );
97  
98  }