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 fr.paris.lutece.plugins.dila.business.fichelocale.dto.LocalCardChapterDTO;
37  import fr.paris.lutece.plugins.dila.business.fichelocale.dto.LocalCardDTO;
38  import fr.paris.lutece.plugins.dila.business.fichelocale.dto.LocalFolderDTO;
39  import fr.paris.lutece.plugins.dila.business.fichelocale.dto.LocalFolderLinkDTO;
40  
41  import java.util.List;
42  
43  
44  /**
45   * Service for validation
46   */
47  public interface IDilaValidationService
48  {
49      /**
50       * Validate a folder
51       * @param folderBean the folder to validate
52       * @param listLinks the links to validate
53       * @return error key or null
54       */
55      String validateLocalFolder( LocalFolderDTO folderBean, List<LocalFolderLinkDTO> listLinks );
56  
57      /**
58       * Validate a card
59       * @param cardBean the card to validate
60       * @param listChapters the chapters to validate
61       * @return error key or null
62       */
63      String validateLocalCard( LocalCardDTO cardBean, List<LocalCardChapterDTO> listChapters );
64  
65      /**
66       * Validate the root theme
67       * @param folderBean the folder to validate
68       * @return the theme parent title if exists, <code>null</code> otherwise
69       */
70      String validateRootTheme( LocalFolderDTO folderBean );
71  
72      /**
73       * Validate the sibling folder
74       * @param folderBean the folder to validate
75       * @return error key or null
76       */
77      String validateLinkedFolder( LocalFolderDTO folderBean );
78  
79      /**
80       * Check if parent folder is valid
81       * @param cardBean the card to validate
82       * @param strId the parent folder id
83       * @return error key or null
84       */
85      String validateRootFolder( LocalCardDTO cardBean, String strId );
86  
87      /**
88       * Check if a card for a link id is valid
89       * @param folderBean the folder to validate
90       * @param strId the card for a link id
91       * @param link the card for a link
92       * @return error key or null
93       */
94      String validateLinkCard( LocalFolderDTO folderBean, String strId, LocalFolderLinkDTO link );
95  
96      /**
97       * Check if a sibling card id is valid
98       * @param cardBean the card to validate
99       * @param strId the sibling card id
100      * @return error key or null
101      */
102     String validateLinkedCard( LocalCardDTO cardBean, String strId );
103 }