View Javadoc
1   /*
2    * Copyright (c) 2002-2022, City of 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.forms.modules.template.service;
35  
36  import java.util.List;
37  
38  import fr.paris.lutece.plugins.forms.business.FormDisplay;
39  import fr.paris.lutece.plugins.forms.web.ICompositeDisplay;
40  
41  public interface ITemplateService
42  {
43      /**
44       * Get the full children composite list of the given template
45       * 
46       * @param nIdTemplate
47       *            The template primary key
48       * @return the Html of the given template
49       */
50      List<ICompositeDisplay> getTemplateCompositeList( int nIdTemplate );
51  
52      /**
53       * Get the right composite from the given templateDisplay
54       * 
55       * @param templateDisplay
56       *            The templateDisplay
57       * @param nIterationNumber
58       *            the iteration number
59       * @return the right composite
60       */
61      ICompositeDisplay templateDisplayToComposite( FormDisplay templateDisplay, int nIterationNumber );
62  
63      /**
64       * Remove a given template and the all its formDisplays. The responses, group/question associated to the displays will be deleted. All the descendants of
65       * the displays will also be removed
66       * 
67       * @param nIdTemplate
68       *            The Template Id
69       */
70      void deleteTemplate( int nIdTemplate );
71  }