1 /*
2 * Copyright (c) 2002-2022, City of 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.comment.service;
35
36 import fr.paris.lutece.plugins.workflow.modules.comment.business.CommentValue;
37 import fr.paris.lutece.portal.business.user.AdminUser;
38 import fr.paris.lutece.portal.service.plugin.Plugin;
39
40 import org.springframework.transaction.annotation.Transactional;
41
42 /**
43 *
44 * ICommentValueService
45 *
46 */
47 public interface ICommentValueService
48 {
49 /**
50 * Creation of an instance of comment value
51 *
52 * @param commentValue
53 * The instance of comment value which contains the informations to store
54 * @param plugin
55 * the plugin
56 */
57 @Transactional( "workflow.transactionManager" )
58 void create( CommentValue commentValue, Plugin plugin );
59
60 /**
61 * Remove comment value by history
62 *
63 * @param nIdHistory
64 * the history key
65 * @param nIdTask
66 * The task key
67 * @param plugin
68 * the Plugin
69 */
70 @Transactional( "workflow.transactionManager" )
71 void removeByHistory( int nIdHistory, int nIdTask, Plugin plugin );
72
73 /**
74 * Remove comment value by task
75 *
76 * @param nIdTask
77 * The task key
78 * @param plugin
79 * the Plugin
80 */
81 @Transactional( "workflow.transactionManager" )
82 void removeByTask( int nIdTask, Plugin plugin );
83
84 /**
85 * Load the CommentValue Object
86 *
87 * @param nIdHistory
88 * the history id
89 * @param nIdTask
90 * the task id
91 * @param plugin
92 * the plugin
93 * @return the Config Object
94 */
95 CommentValue findByPrimaryKey( int nIdHistory, int nIdTask, Plugin plugin );
96
97 /**
98 * Tests whether the specified user is the owner of the comment
99 *
100 * @param nIdHistory
101 * the history id used to retrieve the comment
102 * @param adminUser
103 * the user
104 * @return {@code true} if the user is the owner, {@code false} otherwise
105 */
106 boolean isOwner( int nIdHistory, AdminUser adminUser );
107 }