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.donneescomplementaires.dto.ComplementaryDataDTO;
37
38 import org.w3c.dom.Document;
39
40 import java.util.List;
41
42 import javax.xml.parsers.DocumentBuilder;
43
44
45 /**
46 * Service for {@link ComplementaryDataDTO}
47 */
48 public interface IDilaComplementaryDataService
49 {
50 /**
51 * Method to get all {@link ComplementaryDataDTO}
52 * @return list of all {@link ComplementaryDataDTO}
53 */
54 List<ComplementaryDataDTO> findAll( );
55
56 /**
57 * Create a new {@link ComplementaryDataDTO}
58 * @param dto the {@link ComplementaryDataDTO} to create
59 * @return the id of new {@link ComplementaryDataDTO}
60 */
61 Long create( ComplementaryDataDTO dto );
62
63 /**
64 * Check if a card already has a complement
65 * @param id the id to check
66 * @return <code>true</code> if card already has a complement,
67 * <code>false</code> otherwise
68 */
69 boolean cardHasComplement( String id );
70
71 /**
72 * Find a {@link ComplementaryDataDTO} by its id
73 * @param id the id to find
74 * @return the corresponding {@link ComplementaryDataDTO}
75 */
76 ComplementaryDataDTO findById( Long id );
77
78 /**
79 * Update a {@link ComplementaryDataDTO}
80 * @param complementaryData the {@link ComplementaryDataDTO} to
81 * update
82 */
83 void update( ComplementaryDataDTO complementaryData );
84
85 /**
86 * Delete a {@link ComplementaryDataDTO}
87 * @param id the id to delete
88 */
89 void delete( Long id );
90
91 /**
92 * Insert complementary data in given fiche
93 * @param cardTechnicalId the card to complete
94 * @param categoryId the categoy id
95 * @param builder the builder
96 * @param document the document to complete
97 * @return the completed document
98 */
99 Document insertComplementaryData( Long cardTechnicalId, Long categoryId, DocumentBuilder builder, Document document );
100
101 /**
102 * Find {@link ComplementaryDataDTO} by card and audience
103 * @param cardId fiche id
104 * @param audienceId audience id
105 * @return the found {@link ComplementaryDataDTO}
106 */
107 ComplementaryDataDTO findByCardAndAudience( Long cardId, Long audienceId );
108 }