1 /*
2 * Copyright (c) 2002-2024, 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.appointmentants.service.history;
35
36 import fr.paris.lutece.plugins.workflow.modules.appointmentants.business.history.TaskAntsAppointmentHistory;
37 import fr.paris.lutece.portal.service.plugin.Plugin;
38
39 public interface ITaskAntsAppointmentHistoryService
40 {
41 /**
42 * Create a new entry in the ANTS task's history table
43 *
44 * @param taskAntsAppointmentHistory
45 * TaskAntsAppointmentHistory object to insert
46 * @param plugin
47 * The Plugin
48 */
49 void create( TaskAntsAppointmentHistory taskAntsAppointmentHistory, Plugin plugin );
50
51 /**
52 * Remove the ANTS task's history associated with the history
53 * and task specified in parameters
54 *
55 * @param idHistory
56 * ID of the resource history used for the task
57 * @param idTask
58 * ID of the task
59 * @param plugin
60 * The Plugin
61 */
62 void removeByHistory( int idHistory, int idTask, Plugin plugin );
63
64 /**
65 * Remove the ANTS task's history associated with the task specified in parameters
66 *
67 * @param idTask
68 * ID of the task
69 * @param plugin
70 * The Plugin
71 */
72 void removeByTask( int idTask, Plugin plugin );
73
74 /**
75 * Find the data that matches the specified parameters, from the ANTS task's history table
76 *
77 * @param idHistory
78 * ID of the resource history used for the task
79 * @param idTask
80 * ID of the task
81 * @param plugin
82 * The Plugin
83 * @return The TaskAntsAppointmentHistory object matching the parameters, or null if none was found
84 */
85 TaskAntsAppointmentHistory findByPrimaryKey( int idHistory, int idTask, Plugin plugin );
86 }