1 /*
2 * Copyright (c) 2002-2017, 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.archive.business;
35
36 import fr.paris.lutece.portal.service.plugin.Plugin;
37
38
39 /**
40 *
41 * IArchiveItemDAO
42 *
43 */
44 public interface IArchiveItemDAO
45 {
46 /**
47 * return the next archive item queue id
48 * @param plugin {@link Plugin}
49 * @return the next archive item queue id
50 */
51 int nextArchiveItemId( Plugin plugin );
52
53 /**
54 * update the archive state
55 * @param nIdArchiveItem the id of the archive item
56 * @param strState the new state
57 * @param plugin {@link Plugin}
58 */
59 void updateState( int nIdArchiveItem, String strState, Plugin plugin );
60
61 /**
62 * Insert a new archive item in the database queue.
63 * @param archiveItem the archive item to insert
64 * @param plugin {@link Plugin}
65 * @return the id of the archive item
66 */
67 int insert( ArchiveItem archiveItem, Plugin plugin );
68
69 /**
70 * load the archive item wich the id is specified in parameter
71 * @param nIdArchiveItem the archive item id
72 * @param plugin {@link Plugin}
73 * @return {@link ArchiveItem}
74 */
75 ArchiveItem load( int nIdArchiveItem, Plugin plugin );
76
77 /**
78 * Delete the archive item record in the table
79 * @param nIdArchiveItem The indentifier of the archive item to remove
80 * @param plugin {@link Plugin}
81 */
82 void delete( int nIdArchiveItem, Plugin plugin );
83 }