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 import fr.paris.lutece.portal.service.spring.SpringContextService;
38
39
40 /**
41 * This class provides Data Access methods for ArchiveItem objects
42 */
43 public final class ArchiveItemHome
44 {
45 // Static variable pointed at the DAO instance
46 private static IArchiveItemDAO _dao = (IArchiveItemDAO) SpringContextService.getBean( "archive.archiveItemDAO" );
47
48 /**
49 * Creates a new ArchiveItemHome object.
50 */
51 private ArchiveItemHome( )
52 {
53 }
54
55 /**
56 * Insert a new archive item in the database queue.
57 * @param archiveItem the archive item to insert
58 * @param plugin {@link Plugin}
59 * @return the id of the archive item
60 */
61 public static int create( ArchiveItem archiveItem, Plugin plugin )
62 {
63 return _dao.insert( archiveItem, plugin );
64 }
65
66 /**
67 * Delete the archive item record in the table
68 * @param nIdArchiveItem The indentifier of the archive item to remove
69 * @param plugin {@link Plugin}
70 *
71 */
72 public static void delete( int nIdArchiveItem, Plugin plugin )
73 {
74 _dao.delete( nIdArchiveItem, plugin );
75 }
76
77 /**
78 * Return the first archive item in the queue
79 * @param plugin {@link Plugin}
80 * @return the first archive item in the queue
81 */
82 public static ArchiveItem getNextArchiveItemQueue( Plugin plugin )
83 {
84 //get the id of the next mail item queue
85 int nIdArchiveItem = _dao.nextArchiveItemId( plugin );
86
87 if ( nIdArchiveItem != -1 )
88 {
89 return findByPrimaryKey( nIdArchiveItem, plugin );
90 }
91
92 return null;
93 }
94
95 /**
96 * update the archive state
97 * @param nIdArchiveItem the id of the archive item
98 * @param strState the new state
99 * @param plugin {@link Plugin}
100 */
101 public static void updateState( int nIdArchiveItem, String strState, Plugin plugin )
102 {
103 _dao.updateState( nIdArchiveItem, strState, plugin );
104 }
105
106 /**
107 * load the archive item wich the id is specified in parameter
108 * @param nKey the archive item id
109 * @param plugin {@link Plugin}
110 * @return {@link ArchiveItem}
111 */
112 public static ArchiveItem findByPrimaryKey( int nKey, Plugin plugin )
113 {
114 return _dao.load( nKey, plugin );
115 }
116 }