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.LocalCardDTO;
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 For {@link LocalCardDTO}
47 */
48 public interface IDilaLocalCardService
49 {
50 /**
51 * Create a {@link LocalCardDTO}
52 * @param card the {@link LocalCardDTO} to create
53 * @return the id of new card
54 */
55 Long create( LocalCardDTO card );
56
57 /**
58 * Find a card id by its local id
59 * @param localId the id find
60 * @return the corresponding id
61 */
62 Long findCardIdByLocalId( String localId );
63
64 /**
65 * Delete a {@link LocalCardDTO}
66 * @param localCardId the id to delete
67 */
68 void delete( Long localCardId );
69
70 /**
71 * Find a {@link LocalCardDTO} by its id local
72 * @param localId the id to find
73 * @return the corresponding {@link LocalCardDTO}
74 */
75 LocalCardDTO findCardByLocalId( Long localId );
76
77 /**
78 * Update a {@link LocalCardDTO}
79 * @param card the card to update
80 */
81 void update( LocalCardDTO card );
82
83 /**
84 * Check if a {@link LocalCardDTO} reference the idLocal as parent folder
85 * @param localId the id to check
86 * @return <code>true</code> if at least one fiche exists,
87 * <code>false</code> otherwise
88 */
89 boolean isCardWithParentId( String localId );
90
91 /**
92 * Insert local links into document
93 * @param parentId the parent id
94 * @param builder the builder to use
95 * @param document the document to complete
96 * @return the document with links
97 */
98 Document insertCardLinks( String parentId, DocumentBuilder builder, Document document );
99
100 /**
101 * Find all {@link LocalCardDTO} attached to parent folder
102 * @param parentId the parent folder id
103 * @return the attached local cards
104 */
105 List<LocalCardDTO> findLocalCardsByParentFolder( String parentId );
106 }