View Javadoc
1   /*
2    * Copyright (c) 2002-2020, 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.quicklinks.business;
35  
36  import fr.paris.lutece.portal.service.plugin.Plugin;
37  
38  import java.util.Collection;
39  
40  /**
41   * Manage the Entry
42   *
43   */
44  public interface IEntryDAO
45  {
46      /**
47       * Find all {@link Entry} specified by filter
48       *
49       * @param entryFilter
50       *            The {@link EntryFilter} object
51       * @param plugin
52       *            the {@link Plugin}
53       * @return the instance of the EntryType
54       */
55      Collection<IEntry> findByFilter( EntryFilter entryFilter, Plugin plugin );
56  
57      /**
58       * Insert the Entry
59       *
60       * @param entry
61       *            The {@link Entry} to insert
62       * @param plugin
63       *            The {@link Plugin}
64       * @return The Entry
65       */
66      IEntry="../../../../../../fr/paris/lutece/plugins/quicklinks/business/IEntry.html#IEntry">IEntry insert( IEntry entry, Plugin plugin );
67  
68      /**
69       * Deletes the {@link Entry} whose identifier is specified in parameter
70       *
71       * @param nId
72       *            The identifier of the {@link Entry}
73       * @param plugin
74       *            The {@link Plugin}
75       */
76      void delete( int nId, Plugin plugin );
77  
78      /**
79       * Load the data of the entry type from the table
80       *
81       * @param nId
82       *            The {@link Entry} identifier
83       * @param plugin
84       *            the plugin
85       * @return the instance of the EntryType
86       */
87      IEntry load( int nId, Plugin plugin );
88  
89      /**
90       * Update the {@link Entry}
91       *
92       * @param entry
93       *            The {@link Entry} object
94       * @param plugin
95       *            The {@link Plugin}
96       */
97      void store( IEntry entry, Plugin plugin );
98  }