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.suggest.service.workflow;
35
36 import java.util.ArrayList;
37 import java.util.Collection;
38 import java.util.List;
39
40 import fr.paris.lutece.api.user.User;
41 import fr.paris.lutece.plugins.suggest.business.Suggest;
42 import fr.paris.lutece.plugins.suggest.business.SuggestSubmit;
43 import fr.paris.lutece.plugins.workflowcore.business.state.State;
44 import fr.paris.lutece.portal.service.workflow.WorkflowService;
45
46 /**
47 * Workflow service methods for plugin-suggest
48 */
49 public class SuggestWorkflowService
50 {
51 public static final String BEAN_NAME = "suggest.suggestWorkflowService";
52
53 /**
54 * Private constructor
55 */
56 private SuggestWorkflowService( )
57 {
58 }
59
60 /**
61 * Process the automatic workflow actions when a SuggestSubmit is created
62 *
63 * @param suggest
64 * The Suggest associated with the workflow
65 * @param suggestSubmit
66 * The SuggestSubmit processing the workflow action
67 * @param user
68 * The user
69 */
70 public static void processActionOnSuggestSubmitCreation( Suggest suggest, SuggestSubmit suggestSubmit, User user )
71 {
72 WorkflowService.getInstance( ).getState( suggestSubmit.getIdSuggestSubmit( ), SuggestSubmit.RESOURCE_TYPE, suggest.getIdWorkflow( ),
73 suggest.getIdSuggest( ) );
74 WorkflowService.getInstance( ).executeActionAutomatic( suggestSubmit.getIdSuggestSubmit( ), SuggestSubmit.RESOURCE_TYPE, suggest.getIdWorkflow( ),
75 suggest.getIdSuggest( ), user );
76 }
77
78 /**
79 * Remove the resources linked to the specified workflow and consultation
80 *
81 * @param nIdWorkflow
82 * The workflow's ID
83 * @param nIdSuggest
84 * The consultation's ID
85 * @param user
86 * The user performing the remove action
87 */
88 public static void removeResources( int nIdWorkflow, int nIdSuggest, User user )
89 {
90 WorkflowService workflowService = WorkflowService.getInstance( );
91 if ( workflowService.isAvailable( ) )
92 {
93 List<Integer> listIdWorkflowState = getListIdWorkflowState( nIdWorkflow, user );
94 List<Integer> listIdResources = workflowService.getAuthorizedResourceList( SuggestSubmit.RESOURCE_TYPE, nIdWorkflow, listIdWorkflowState,
95 nIdSuggest, user );
96
97 workflowService.doRemoveWorkFlowResourceByListId( listIdResources, SuggestSubmit.RESOURCE_TYPE, nIdWorkflow );
98 }
99 }
100
101 /**
102 * Retrieve the list of state identifiers for the specified workflow. The list is filtered depending on the permissions of the specified user.
103 *
104 * @param nIdWorkflow
105 * the workflow id
106 *
107 * @param adminUser
108 * the user
109 *
110 * @return the list of workflow state identifiers
111 */
112 public static List<Integer> getListIdWorkflowState( int nIdWorkflow, User user )
113 {
114 List<Integer> listIdState = new ArrayList<>( );
115 Collection<State> collectionStates = WorkflowService.getInstance( ).getAllStateByWorkflow( nIdWorkflow, user );
116
117 for ( State state : collectionStates )
118 {
119 listIdState.add( state.getId( ) );
120 }
121 return listIdState;
122 }
123 }