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.portal.business.resourceenhancer;
35
36 import java.util.Map;
37
38 import javax.servlet.http.HttpServletRequest;
39
40 /**
41 *
42 * Interface IResourceManager : enhance model and process additionnal actions
43 *
44 */
45 public interface IResourceManager
46 {
47 /**
48 * Add datas to the create document model use in the template
49 *
50 * @param model
51 * the map use in the template
52 */
53 void getCreateResourceModelAddOn( Map<String, Object> model );
54
55 /**
56 * Perform actions associated to the document creation
57 *
58 * @param request
59 * The HTTP request
60 * @param strResourceType
61 * the resource type
62 * @param nResourceId
63 * the resource id
64 */
65 void doCreateResourceAddOn( HttpServletRequest request, String strResourceType, int nResourceId );
66
67 /**
68 * Add datas to the modify document model use in the template
69 *
70 * @param model
71 * the map use in the template
72 * @param strResourceType
73 * the resource type
74 * @param nResourceId
75 * the resource id
76 */
77 void getModifyResourceModelAddOn( Map<String, Object> model, String strResourceType, int nResourceId );
78
79 /**
80 * Perform actions associated to the document modification
81 *
82 * @param request
83 * The HTTP request
84 * @param strResourceType
85 * the resource type
86 * @param nResourceId
87 * the resource id
88 */
89 void doModifyResourceAddOn( HttpServletRequest request, String strResourceType, int nResourceId );
90
91 /**
92 * Perform actions associated to the document deletion
93 *
94 * @param request
95 * The HTTP request
96 * @param strResourceType
97 * the resource type
98 * @param nResourceId
99 * the resource id
100 */
101 void doDeleteResourceAddOn( HttpServletRequest request, String strResourceType, int nResourceId );
102
103 /**
104 * Perform actions associated to the document download
105 *
106 * @param request
107 * The HTTP request
108 * @param strResourceType
109 * the resource type
110 * @param nResourceId
111 * the resource id
112 */
113 void doDownloadResourceAddOn( HttpServletRequest request, String strResourceType, int nResourceId );
114 }