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.dila.service; 35 36 import fr.paris.lutece.plugins.dila.business.fichelocale.dto.LocalFolderDTO; 37 38 import org.w3c.dom.Document; 39 40 import java.util.List; 41 42 import javax.xml.parsers.DocumentBuilder; 43 44 45 /** 46 * Interface service for {@link LocalFolderDTO} 47 */ 48 public interface IDilaLocalFolderService 49 { 50 /** 51 * Create a {@link LocalFolderDTO} 52 * @param folder the folder to create 53 * @return the id of new {@link LocalFolderDTO} 54 */ 55 Long create( LocalFolderDTO folder ); 56 57 /** 58 * Find folde id by its local id 59 * @param localId the local id to find 60 * @return the id of corresponding {@link LocalFolderDTO} 61 */ 62 Long findFolderIdByLocalId( String localId ); 63 64 /** 65 * Delete a {@link LocalFolderDTO} 66 * @param localFolderId the id to delete 67 */ 68 void delete( Long localFolderId ); 69 70 /** 71 * Find a {@link LocalFolderDTO} by its local id 72 * @param localId the local id to find 73 * @return the corresponding local folder 74 */ 75 LocalFolderDTO findFolderByLocalId( Long localId ); 76 77 /** 78 * Update a {@link LocalFolderDTO} 79 * @param folder the {@link LocalFolderDTO} to update 80 */ 81 void update( LocalFolderDTO folder ); 82 83 /** 84 * Insert local folders links into document 85 * @param parentId the parent id 86 * @param builder the builder to use 87 * @param document the document to complete 88 * @return the document with links 89 */ 90 Document insertFolderLinks( String parentId, DocumentBuilder builder, Document document ); 91 92 /** 93 * Find all {@link LocalFolderDTO} attached to parent folder 94 * @param idParent the parent folder id 95 * @return the attached local cards 96 */ 97 List<LocalFolderDTO> findLocalFoldersByParentTheme( String idParent ); 98 }