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.state.service;
35
36 import java.util.List;
37
38 import fr.paris.lutece.plugins.workflow.modules.state.business.ChooseStateTaskConfig;
39 import fr.paris.lutece.plugins.workflowcore.business.resource.ResourceWorkflow;
40 import fr.paris.lutece.plugins.workflowcore.service.task.ITask;
41 import fr.paris.lutece.portal.service.spring.SpringContextService;
42 import fr.paris.lutece.util.ReferenceList;
43
44 /**
45 * Service for IChooseStateTask
46 */
47 public interface IChooseStateTaskService
48 {
49
50 /**
51 * Get the list of states
52 *
53 * @param nIdAction
54 * the id action
55 * @return a ReferenceList
56 */
57 ReferenceList getListStates( int nIdAction );
58
59 /**
60 * Get the list of implemented {@link IChooseStateController}
61 *
62 * @return
63 */
64 default List<IChooseStateController> getControllerList( )
65 {
66 return SpringContextService.getBeansOfType( IChooseStateController.class );
67 }
68
69 /**
70 * Load config of task.
71 *
72 * @param task
73 * @return
74 */
75 ChooseStateTaskConfig loadConfig( ITask task );
76
77 /**
78 * Change the state of the given resource if the control is satisfied.
79 *
80 * @param nIdResource
81 * @param strResourceType
82 * @param task
83 * @param config
84 * @param nIdWorkflow
85 * @param oldState
86 */
87 void chooseNewState( int nIdResource, String strResourceType, ITask task, ChooseStateTaskConfig config, int nIdWorkflow, int oldState );
88
89 /**
90 * Load a resource by it History.
91 *
92 * @param nIdHistory
93 * @param nIdWorkflow
94 * @return
95 */
96 ResourceWorkflow getResourceByHistory( int nIdHistory, int nIdWorkflow );
97
98 /**
99 * Get the Controller of the config
100 *
101 * @param config
102 * @return
103 */
104 IChooseStateController getController( ChooseStateTaskConfig config );
105 }