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.business.fichelocale.dao;
35  
36  import fr.paris.lutece.plugins.dila.business.fichelocale.dto.LocalCardDTO;
37  
38  import java.util.List;
39  
40  
41  /**
42   * DAO for {@link LocalCardDTO}
43   */
44  public interface ILocalCardDAO
45  {
46      /**
47       * Create a {@link LocalCardDTO}
48       * @param card the card to create
49       * @return the id of new card
50       */
51      Long insert( LocalCardDTO card );
52  
53      /**
54       * Find a {@link LocalCardDTO} id by its local id
55       * @param localId the id to find
56       * @return the id of corresponding {@link LocalCardDTO}
57       */
58      Long findCardIdByLocalId( String localId );
59  
60      /**
61       * Delete a card
62       * @param localCardId the id of card to delete
63       */
64      void delete( Long localCardId );
65  
66      /**
67       * Find a {@link LocalCardDTO} by its id local
68       * @param localId the id to find
69       * @return the corresponding {@link LocalCardDTO}
70       */
71      LocalCardDTO findCardByLocalId( Long localId );
72  
73      /**
74       * Update a {@link LocalCardDTO}
75       * @param card the card to update
76       */
77      void store( LocalCardDTO card );
78  
79      /**
80       * Check if a {@link LocalCardDTO} reference the idLocal as parent dossier
81       * @param localId the id to check
82       * @return <code>true</code> if at least one card exists, <code>false</code>
83       *         otherwise
84       */
85      boolean isCardWithParentId( String localId );
86  
87      /**
88       * Find all {@link LocalCardDTO} attached to parent folder
89       * @param parentId the parent folder id
90       * @return the attached local cards
91       */
92      List<LocalCardDTO> findLocalCardsByParentFolder( String parentId );
93  }