1 /*
2 * Copyright (c) 2002-2021, 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.unittree.service.selection;
35
36 import java.util.Locale;
37
38 import javax.servlet.http.HttpServletRequest;
39
40 import fr.paris.lutece.plugins.workflowcore.service.task.ITask;
41
42 /**
43 * <p>
44 * This class is a handler for unit selection configuration
45 * </p>
46 * <p>
47 * The unit selection configuration is displayed in the configuration of the workflow task to assign a resource to a unit.
48 * </p>
49 *
50 */
51 public interface IConfigurationHandler
52 {
53 /**
54 * Gives the title of the unit selection displayed in the configuration form.
55 *
56 * @param locale
57 * the locale
58 * @return the title
59 */
60 String getTitle( Locale locale );
61
62 /**
63 * Gives the HTML representing the configuration form to display in the workflow task
64 *
65 * @param locale
66 * the locale
67 * @param task
68 * the task associated to the configuration
69 * @return the HTML in a String
70 */
71 String getDisplayedForm( Locale locale, ITask task );
72
73 /**
74 * Saves the configuration
75 *
76 * @param request
77 * the request containing the configuration
78 * @param task
79 * the task associated to the configuration
80 * @return the error or {@code null} if there is no error
81 */
82 String saveConfiguration( HttpServletRequest request, ITask task );
83
84 /**
85 * Removes the configuration
86 *
87 * @param task
88 * the task associated to the configuration
89 */
90 void removeConfiguration( ITask task );
91 }