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.donneescomplementaires.dao;
35  
36  import fr.paris.lutece.plugins.dila.business.donneescomplementaires.dto.ComplementaryDataDTO;
37  
38  import java.util.List;
39  
40  
41  /**
42   * DAO for {@link ComplementaryDataDTO}
43   */
44  public interface IComplementaryDataDAO
45  {
46      /**
47       * Method to get all {@link ComplementaryDataDTO}
48       * @return list of all {@link ComplementaryDataDTO}
49       */
50      List<ComplementaryDataDTO> findAll( );
51  
52      /**
53       * Create a new {@link ComplementaryDataDTO}
54       * @param dto the {@link ComplementaryDataDTO} to create
55       * @return the id of new {@link ComplementaryDataDTO}
56       */
57      Long insert( ComplementaryDataDTO dto );
58  
59      /**
60       * Check if a fiche has already a complement
61       * @param id the id to check
62       * @return <code>true</code> if fiche has already a complement,
63       *         <code>false</code> otherwise
64       */
65      boolean cardHasComplement( String id );
66  
67      /**
68       * Find a {@link ComplementaryDataDTO} by its id
69       * @param id the id to find
70       * @return the corresponding {@link ComplementaryDataDTO}
71       */
72      ComplementaryDataDTO findById( Long id );
73  
74      /**
75       * Update a {@link ComplementaryDataDTO}
76       * @param donneesComplementaires the {@link ComplementaryDataDTO} to
77       *            update
78       */
79      void store( ComplementaryDataDTO donneesComplementaires );
80  
81      /**
82       * Delete a {@link ComplementaryDataDTO}
83       * @param id the id to delete
84       */
85      void delete( Long id );
86  
87      /**
88       * Find {@link ComplementaryDataDTO} by fiche and audience
89       * @param cardId fiche id
90       * @param audienceId audience id
91       * @return the found {@link ComplementaryDataDTO}
92       */
93      ComplementaryDataDTO findByCardAndAudience( Long cardId, Long audienceId );
94  }