View Javadoc
1   /*
2    * Copyright (c) 2002-2019, 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.workflow.modules.reply.service;
35  
36  import java.util.List;
37  
38  import javax.servlet.http.HttpServletRequest;
39  
40  import org.springframework.transaction.annotation.Transactional;
41  
42  import fr.paris.lutece.plugins.workflow.modules.reply.business.task.Reply;
43  import fr.paris.lutece.portal.service.message.SiteMessageException;
44  import fr.paris.lutece.util.ReferenceList;
45  
46  /**
47   *
48   * IReply Service
49   *
50   */
51  public interface IReplyService
52  {
53      // SET
54  
55      /**
56       * Set the site message
57       * 
58       * @param request
59       *            the HTTP request
60       * @param strMessage
61       *            the message
62       * @param nTypeMessage
63       *            the message type
64       * @param strUrlReturn
65       *            the url return
66       * @throws SiteMessageException
67       *             the site message
68       */
69      void setSiteMessage( HttpServletRequest request, String strMessage, int nTypeMessage, String strUrlReturn ) throws SiteMessageException;
70  
71      // CRUD
72  
73      /**
74       * Create an reply
75       * 
76       * @param reply
77       */
78      @Transactional( ReplyPlugin.BEAN_TRANSACTION_MANAGER )
79      void create( Reply reply );
80  
81      /**
82       * Update an reply
83       * 
84       * @param reply
85       */
86      @Transactional( ReplyPlugin.BEAN_TRANSACTION_MANAGER )
87      void update( Reply reply );
88  
89      /**
90       * Find an reply
91       * 
92       * @param nIdHistory
93       *            the id history
94       * @param nIdTask
95       *            the id task
96       * @return a reply
97       */
98      Reply find( int nIdHistory, int nIdTask );
99  
100     /**
101      * Find replys by a given id task
102      * 
103      * @param nIdTask
104      *            the id task
105      * @return the list of replys
106      */
107     List<Reply> findByIdTask( int nIdTask );
108 
109     /**
110      * Remove an reply
111      * 
112      * @param nIdHistory
113      *            the id history
114      * @param nIdTask
115      *            the id task
116      */
117     @Transactional( ReplyPlugin.BEAN_TRANSACTION_MANAGER )
118     void removeByIdHistory( int nIdHistory, int nIdTask );
119 
120     /**
121      * Remove an reply by id task
122      * 
123      * @param nIdTask
124      *            the id task
125      */
126     @Transactional( ReplyPlugin.BEAN_TRANSACTION_MANAGER )
127     void removeByIdTask( int nIdTask );
128 
129 }