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.Locale;
37
38 import javax.servlet.http.HttpServletRequest;
39
40 import fr.paris.lutece.plugins.workflowcore.business.config.ITaskConfig;
41 import fr.paris.lutece.plugins.workflowcore.service.task.ITask;
42
43 public interface IChooseStateController
44 {
45
46 /**
47 * The label key of the service.
48 *
49 * @return
50 */
51 String getLabelKey( );
52
53 /**
54 * The help key of the service.
55 *
56 * @return
57 */
58 String getHelpKey( );
59
60 /**
61 * The name of the service.
62 *
63 * @return
64 */
65 String getName( );
66
67 /**
68 * controls the result of the control.
69 *
70 * @return
71 */
72 boolean control( ITask task, int nIdResource, String strResourceType );
73
74 /**
75 * Indicates if this controller need a config.
76 *
77 * @return
78 */
79 default boolean hasConfig( )
80 {
81 return false;
82 }
83
84 /**
85 * Returns the informations which must be displayed in the configuration
86 *
87 * @param request
88 * request
89 * @param locale
90 * locale
91 * @param config
92 * the taskconfig
93 * @return the information which must be displayed in the task configuration
94 */
95 default String getDisplayConfigForm( HttpServletRequest request, Locale locale, ITaskConfig config )
96 {
97 return null;
98 }
99
100 /**
101 * Process the action during the configuration of the task.
102 *
103 * @param request
104 * @param locale
105 * @param config
106 */
107 default void doSaveConfig( HttpServletRequest request, Locale locale, ITask task )
108 {
109 }
110
111 /**
112 * Delete controller custom config.
113 *
114 * @param task
115 */
116 default void doRemoveConfig( ITask task )
117 {
118 }
119 }