1 /*
2 * Copyright (c) 2002-2023, 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.document.business;
35
36 import java.util.List;
37
38 /**
39 *
40 * IIndexerActionDAO
41 *
42 */
43 public interface IIndexerActionDAO
44 {
45 /**
46 * Generates a new primary key
47 *
48 * @return The new primary key
49 */
50 int newPrimaryKey( );
51
52 /**
53 * Insert a new record in the table.
54 *
55 * @param indexerAction
56 * instance of the IndexerAction object to insert
57 */
58 void insert( IndexerAction indexerAction );
59
60 /**
61 * Load the data of the IndexerAction from the table
62 *
63 * @param nId
64 * The identifier of the action
65 * @return the instance of the IndexerAction
66 */
67 IndexerAction load( int nId );
68
69 /**
70 * Delete a record from the table
71 *
72 * @param nId
73 * The identifier of the action
74 */
75 void delete( int nId );
76
77 /**
78 * Delete a record from the table
79 *
80 */
81 void deleteAll( );
82
83 /**
84 * Update the indexerAction in the table
85 *
86 * @param indexerAction
87 * instance of the IndexerAction object to update
88 */
89 void store( IndexerAction indexerAction );
90
91 /**
92 * Load the data of all indexerAction and returns them in a list
93 *
94 * @param filter
95 * the search filter
96 * @return The List which contains the data of all action
97 */
98 List<IndexerAction> selectList( IndexerActionFilter filter );
99 }