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.LocalDTO;
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 LocalDTO}
47 */
48 public interface IDilaLocalService
49 {
50 /**
51 * Find all {@link LocalDTO}
52 * @return list of all {@link LocalDTO}
53 */
54 List<LocalDTO> findAll( );
55
56 /**
57 * Create a {@link LocalDTO}
58 * @param local the {@link LocalDTO} to create
59 * @param addIdToBreadcrumb <code>true</code> if id must be id to
60 * breadcrumb, <code>false</code> otherwise
61 * @return the id of new {@link LocalDTO}
62 */
63 Long create( LocalDTO local, boolean addIdToBreadcrumb );
64
65 /**
66 * Delete a {@link LocalDTO}
67 * @param idLocal the id to delete
68 */
69 void delete( String idLocal );
70
71 /**
72 * Update a {@link LocalDTO}
73 * @param localDTO the {@link LocalDTO} to update
74 * @param addIdToBreadcrumb <code>true</code> if id must be id to
75 * breadcrumb, <code>false</code> otherwise
76 */
77 void update( LocalDTO localDTO, boolean addIdToBreadcrumb );
78
79 /**
80 * Find xml content of {@link LocalDTO} by its id
81 * @param id the id
82 * @return the xml
83 */
84 String findXmlById( Long id );
85
86 /**
87 * Find a title by its id and type
88 * @param id the id to find
89 * @param type the type
90 * @param idAudience the id audience
91 * @return the title of corresponding {@link LocalDTO}
92 */
93 String findTitleByIdAndTypeAndAudience( Long id, Long type, Long idAudience );
94
95 /**
96 * Find a {@link LocalDTO} by its id and type
97 * @param id the id to find
98 * @param type the type
99 * @param idAudience the id audience
100 * @return the corresponding {@link LocalDTO}
101 */
102 LocalDTO findLocalByIdAndTypeAndAudience( Long id, Long type, Long idAudience );
103
104 /**
105 * Insert "Fiche locale" resource in document
106 * @param categoryId the audience to check
107 * @param builder the document builder
108 * @param document the document
109 * @return the updated document
110 */
111 Document insertLastCardsLinks( Long categoryId, DocumentBuilder builder, Document document );
112
113 /**
114 * Find all {@link LocalDTO} by audience id
115 * @param audienceId the audience id
116 * @return all {@link LocalDTO} in audience id
117 */
118 List<LocalDTO> findAllByAudienceId( Long audienceId );
119 }