1 /* 2 * Copyright (c) 2002-2014, 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.directory.modules.pdfproducerarchive.business.zipbasket; 35 36 import fr.paris.lutece.portal.service.plugin.Plugin; 37 38 import java.util.Date; 39 import java.util.List; 40 41 42 /** 43 * IZipBasketDAO 44 * 45 */ 46 public interface IZipBasketDAO 47 { 48 /** 49 * this method add a new zip in the basket 50 * @param strName the name of the futur zip 51 * @param nIdAdminUser id of admin user 52 * @param plugin plugin 53 * @param nIdDirectory id of directory 54 * @param nIdRecord id of record 55 * @param nArchiveItemKey id of the archive item 56 */ 57 void addZipBasket( String strName, int nIdAdminUser, Plugin plugin, int nIdDirectory, int nIdRecord, 58 int nArchiveItemKey ); 59 60 /** 61 * This SQL method check if the zip is already exists 62 * @param nIdAdminUser id of admin user 63 * @param plugin plugin 64 * @param nIdDirectory id of directory 65 * @param nIdRecord id of record 66 * @return true if the zip already exists 67 */ 68 boolean existsZipBasket( int nIdAdminUser, Plugin plugin, int nIdDirectory, int nIdRecord ); 69 70 /** 71 * This method load all zipbasket 72 * @param plugin plugin 73 * @return list of ZipBasket 74 */ 75 List<ZipBasket> loadAllZipBasket( Plugin plugin ); 76 77 /** 78 * This method load all element in basket by id admin user for a specific directory 79 * @param plugin plugin 80 * @param nIdAdminUser id of admin user 81 * @param nIdDirectory id of directory 82 * @return list of ZipBasket 83 */ 84 List<ZipBasket> loadAllZipBasketByAdminUser( Plugin plugin, int nIdAdminUser, int nIdDirectory ); 85 86 /** 87 * This method delete a ZipBasket 88 * @param plugin plugin 89 * @param nIdZipBasket id of the zipbasket 90 */ 91 void deleteZipBasket( Plugin plugin, int nIdZipBasket ); 92 93 /** 94 * This method delete multi ZipBasket 95 * @param plugin plugin 96 * @param listIdZipBasket list of id zipbasket 97 */ 98 void deleteMultiZipBasket( Plugin plugin, List<Integer> listIdZipBasket ); 99 100 /** 101 * this method change de zip file status and modify the date 102 * @param plugin plugin 103 * @param nIdZipBasket id of the zipbasket 104 * @param strStatus the new status 105 */ 106 void changeZipBasketStatus( Plugin plugin, int nIdZipBasket, String strStatus ); 107 108 /** 109 * this method change de zip file url and modify the date 110 * @param plugin plugin 111 * @param nIdZipBasket id of the zipbasket 112 * @param strUrl the new url 113 */ 114 void changeZipBasketUrl( Plugin plugin, int nIdZipBasket, String strUrl ); 115 116 /** 117 * this method return a specific zipbasket by id 118 * @param plugin plugin 119 * @param nIdZipBasket id of the zipbasket 120 * @return the zipbasket by the id 121 */ 122 ZipBasket loadZipBasket( Plugin plugin, int nIdZipBasket ); 123 124 /** 125 * Get the list of zip basket filtered by date 126 * @param plugin the plugin 127 * @param dateExpiry the date expiry 128 * @return a list of {@link ZipBasket} 129 */ 130 List<ZipBasket> loadZipBasketByDate( Plugin plugin, Date dateExpiry ); 131 132 /** 133 * This method load all element in basket by id admin user for a specific 134 * directory by order 135 * @param plugin plugin 136 * @param nIdAdminUser id of admin user 137 * @param nIdDirectory id of directory 138 * @return list of ZipBasket 139 */ 140 List<ZipBasket> loadAllZipBasketByAdminUserOrder( Plugin plugin, int nIdAdminUser, int nIdDirectory ); 141 }