View Javadoc
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 org.w3c.dom.Document;
37  
38  import org.xml.sax.SAXException;
39  
40  import java.io.IOException;
41  
42  import java.util.List;
43  
44  import javax.xml.parsers.DocumentBuilder;
45  
46  
47  /**
48   * This interface provides a method to find XML filenames according to code
49   * pivot
50   *
51   */
52  public interface IDilaPivotLocalService
53  {
54      /**
55       * Find all XML filenames according to strCodePivot and insee number
56       * @param strCodePivot the code pivot
57       * @return list of corresponding filenames
58       */
59      List<String> findByCodePivot( String strCodePivot );
60  
61      /**
62       * Insert pivots data into xml
63       * @param builder the builder to use
64       * @param document the document to complete
65       * @throws SAXException occurs during XML transform
66       * @throws IOException occurs during XML read
67       * @return the document with pivots
68       */
69      Document insertPivots( DocumentBuilder builder, Document document )
70          throws SAXException, IOException;
71  }