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.autopublication; 35 36 import fr.paris.lutece.plugins.document.business.spaces.DocumentSpace; 37 import fr.paris.lutece.portal.business.portlet.Portlet; 38 39 import java.util.Collection; 40 41 /** 42 * This class porvides Data Access methods for DocumentAutoPublicationDAO interface 43 * 44 */ 45 public interface IDocumentAutoPublicationDAO 46 { 47 /** 48 * Insert a new record in the table document_auto_publication 49 * 50 * @param documentAutoPublication 51 * the instance of the DocumentAutoPublication object to insert 52 */ 53 void insert( DocumentAutoPublication documentAutoPublication ); 54 55 /** 56 * Loads the data of Document Auto Publication whose identifier is specified in parameter 57 * 58 * @param nPortletId 59 * The {@link Portlet} identifier 60 * @param nSpaceId 61 * The {@link DocumentSpace} identifier 62 * @return The {@link DocumentAutoPublication} object 63 */ 64 DocumentAutoPublication load( int nPortletId, int nSpaceId ); 65 66 /** 67 * Loads all data Document Auto Publication 68 * 69 * @return The {@link Collection} of {@link DocumentAutoPublication} object 70 */ 71 Collection<DocumentAutoPublication> load( ); 72 73 /** 74 * Load the list of Document Auto Publication whose portlet identifier is specified in parameter 75 * 76 * @param nPortletId 77 * The {@link Portlet} identifier 78 * @return The {@link Collection} of {@link DocumentAutoPublication} object 79 */ 80 Collection<DocumentAutoPublication> selectByPortletId( int nPortletId ); 81 82 /** 83 * Load the list of Document Auto Publication whose {@link DocumentSpace} identifier is specified in parameter 84 * 85 * @param nSpaceId 86 * The {@link DocumentSpace} identifier 87 * @return The {@link Collection} of {@link DocumentAutoPublication} object 88 */ 89 Collection<DocumentAutoPublication> selectBySpaceId( int nSpaceId ); 90 91 /** 92 * Update the record in the table 93 * 94 * @param documentAutoPublication 95 * The DocumentAutoPublication to update 96 */ 97 void store( DocumentAutoPublication documentAutoPublication ); 98 99 /** 100 * Delete records from a Document Auto Publication object identifier in the table document_auto_publication 101 * 102 * @param nPortletId 103 * the portlet identifier 104 * @param nSpaceId 105 * the {@link DocumentSpace} identifier 106 */ 107 void delete( int nPortletId, int nSpaceId ); 108 109 /** 110 * Delete records from a portlet 111 * 112 * @param nPortletId 113 * the portlet identifier 114 */ 115 void deleteAllSpaces( int nPortletId ); 116 }