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.business.prerequisite;
35
36 import fr.paris.lutece.plugins.workflowcore.business.prerequisite.Prerequisite;
37 import fr.paris.lutece.portal.service.plugin.Plugin;
38
39 import java.util.List;
40
41 /**
42 * Interface for prerequisite DAO
43 */
44 public interface IPrerequisiteDAO
45 {
46
47 /**
48 * Get a prerequisite by its primary key
49 *
50 * @param nIdPrerequisite
51 * The id of the prerequisite to get
52 * @param plugin
53 * The plugin
54 * @return The prerequisite, or null if no prerequisite has the given id
55 */
56 Prerequisite findByPrimaryKey( int nIdPrerequisite, Plugin plugin );
57
58 /**
59 * Creates a new prerequisite
60 *
61 * @param prerequisite
62 * The prerequisite to create
63 * @param plugin
64 * the plugin
65 */
66 void create( Prerequisite prerequisite, Plugin plugin );
67
68 /**
69 * Updates a prerequisite
70 *
71 * @param prerequisite
72 * The prerequisite to update
73 * @param plugin
74 * The plugin
75 */
76 void update( Prerequisite prerequisite, Plugin plugin );
77
78 /**
79 * Removes a prerequisite from its id
80 *
81 * @param nIdPrerequisite
82 * the id of the prerequisite to remove
83 * @param plugin
84 * The plugin
85 */
86 void remove( int nIdPrerequisite, Plugin plugin );
87
88 /**
89 * Get a list of prerequisite associated with an action
90 *
91 * @param nIdAction
92 * The id of the action
93 * @param plugin
94 * The plugin
95 * @return The list of prerequisite, or an empty list if no prerequisite is associated with the given action
96 */
97 List<Prerequisite> findByIdAction( int nIdAction, Plugin plugin );
98 }