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.enums.AudienceCategoryEnum;
37 import fr.paris.lutece.plugins.dila.business.fichelocale.dto.XmlDTO;
38
39 import org.jdom2.JDOMException;
40
41 import java.io.File;
42 import java.io.IOException;
43
44
45 /**
46 * Interface for batch xml
47 */
48 public interface IDilaBatchXMLService
49 {
50 /**
51 * Index one file
52 * @param file file to index
53 * @param typeXML type of file
54 * @throws JDOMException occurs during file parsing
55 * @throws IOException occurs during treatment
56 */
57 void processXMLFile( File file, AudienceCategoryEnum typeXML )
58 throws JDOMException, IOException;
59
60 /**
61 * Transform a document in {@link XmlDTO}
62 * @param file source file
63 * @param typeXML type file
64 * @return the build xml
65 * @throws JDOMException occurs during file parsing
66 * @throws IOException occurs during treatment
67 */
68 XmlDTO buildDocument( File file, AudienceCategoryEnum typeXML )
69 throws JDOMException, IOException;
70
71 /**
72 * Delete outdated files
73 */
74 void delete( );
75 }