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.service.prerequisite;
35
36 import fr.paris.lutece.api.user.User;
37 import fr.paris.lutece.plugins.workflowcore.business.prerequisite.IPrerequisiteConfig;
38 import fr.paris.lutece.plugins.workflowcore.service.prerequisite.IAutomaticActionPrerequisiteService;
39
40 /**
41 * Interface for prerequisite services of manual actions.<br>
42 * Before displaying an action, every prerequisite of the action are checked. If one of them failed, the action is not displayed.<br>
43 * <br>
44 * <b>Implementations of this interface must be declared as Spring beans.</b>
45 */
46 public interface IManualActionPrerequisiteService extends IAutomaticActionPrerequisiteService
47 {
48
49 /**
50 * Check if a resource matches this prerequisite.
51 *
52 * @param user
53 * The user trying to do the action
54 * @param nIdResource
55 * The id of the resource
56 * @param strResourceType
57 * The resource type
58 * @param config
59 * The configuration of the prerequisite, or null if the prerequisite has no configuration
60 * @param nIdAction
61 * The id of the action that will be performed if the resource matches every prerequisites
62 * @return True if the resource matches this prerequisite, false otherwise
63 */
64 default boolean canManualActionBePerformed( User user, int nIdResource, String strResourceType, IPrerequisiteConfig config, int nIdAction )
65 {
66 return canActionBePerformed( nIdResource, strResourceType, config, nIdAction );
67 }
68 }