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.digglike.service;
35  
36  import fr.paris.lutece.plugins.digglike.business.CommentSubmit;
37  import fr.paris.lutece.plugins.digglike.business.SubmitFilter;
38  import fr.paris.lutece.portal.service.plugin.Plugin;
39  
40  import java.util.List;
41  
42  import org.springframework.transaction.annotation.Transactional;
43  
44  
45  public interface ICommentSubmitService
46  {
47      /**
48       * Creation of an instance of commentSubmit
49       *
50       * @param commentSubmit The instance of the commentSubmit which contains the informations to store
51       * @param plugin the Plugin
52       *
53       */
54      @Transactional( "digglike.transactionManager" )
55      void create( CommentSubmit commentSubmit, Plugin plugin );
56  
57      /**
58       * Update of the commentSubmit which is specified in parameter
59       *
60       * @param commentSubmit The instance of the commentSubmit which contains the informations to update
61       * @param plugin the Plugin
62       *
63       */
64      @Transactional( "digglike.transactionManager" )
65      void update( CommentSubmit commentSubmit, Plugin plugin );
66  
67      /**
68       * Remove the commentSubmit whose identifier is specified in parameter
69       *
70       * @param nIdCommentSubmit The commentSubmitId
71       * @param plugin the Plugin
72       */
73      @Transactional( "digglike.transactionManager" )
74      void remove( int nIdCommentSubmit, Plugin plugin );
75  
76      /**
77       * Returns an instance of a CommentSubmitwhose identifier is specified in parameter
78       *
79       * @param nKey The commentSubmit primary key
80       * @param plugin the Plugin
81       * @return an instance of commentSubmit
82       */
83      @Transactional( "digglike.transactionManager" )
84      CommentSubmit findByPrimaryKey( int nKey, Plugin plugin );
85  
86      /**
87       * Load the data of all the commentSubmit who verify the filter and returns them in a  list
88       * @param filter the filter
89       * @param plugin the plugin
90       * @return  the list of commentSubmit
91       */
92      @Transactional( "digglike.transactionManager" )
93      List<CommentSubmit> getCommentSubmitList( SubmitFilter filter, Plugin plugin );
94  
95      /**
96       * Load the data of all the commentSubmit who verify the filter and returns them in a  list
97       * @param filter the filter
98       * @param nLimitParentNumber limit the number of parent comment return
99       * @param plugin the plugin
100      * @return  the list of commentSubmit
101      */
102     @Transactional( "digglike.transactionManager" )
103     List<CommentSubmit> getCommentSubmitList( SubmitFilter filter, Integer nLimitParentNumber, Plugin plugin );
104 
105     /**
106      * Load the number of all the commentSubmit who verify the filter
107      * @param filter the filter
108      * @param plugin the plugin
109      * @return  the number of all the commentSubmit who verify the filter
110      */
111     @Transactional( "digglike.transactionManager" )
112     int getCountCommentSubmit( SubmitFilter filter, Plugin plugin );
113 }