View Javadoc
1   /*
2    * Copyright (c) 2002-2021, 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.importexport.business.export;
35  
36  import java.util.List;
37  
38  /**
39   * Interface for the DAO of automatic export configuration
40   */
41  public interface IAutomaticExportConfigDAO
42  {
43      /**
44       * Get a configuration from its id
45       * 
46       * @param nId
47       *            The id of the configuration
48       * @return The configuration, or null if no configuration has the given id
49       */
50      AutomaticExportConfig findById( int nId );
51  
52      /**
53       * Get the list of every configuration
54       * 
55       * @param bLoadColumns
56       *            True to load columns of configurations, false to ignore them
57       * @return The list of every configuration. If there is no configuration, then an empty list is returned
58       */
59      List<AutomaticExportConfig> findAll( boolean bLoadColumns );
60  
61      /**
62       * Insert a new configuration into the database.
63       * 
64       * @param config
65       *            The configuration to update
66       */
67      void insert( AutomaticExportConfig config );
68  
69      /**
70       * Update a configuration. Both the configuration and the list of columns are update
71       * 
72       * @param config
73       *            The configuration to update
74       */
75      void update( AutomaticExportConfig config );
76  
77      /**
78       * Remove a configuration from the database by its id
79       * 
80       * @param nId
81       *            The id of the configuration to remove
82       */
83      void delete( int nId );
84  
85  }