1 /*
2 * Copyright (c) 2002-2014, Mairie de 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 *
43 *Interface IResourceDisplayManager : enhance portlet XML or model with additionnel info
44 *
45 */
46 public interface IResourceDisplayManager
47 {
48 /**
49 * Add to the the XML String additional datas
50 * @param strXml The xml string use by stylesheet
51 * @param strResourceType the resource type
52 * @param nResourceId The resource Id
53 */
54 void getXmlAddOn( StringBuffer strXml, String strResourceType, int nResourceId );
55
56 /**
57 * Add datas to the model use by document template
58 *
59 * @param model The model use by document template
60 * @param strResourceType the ressource Type
61 * @param nIdResource The resource id
62 * @param strPortletId The portlet ID
63 * @param request The HTTP Request
64 */
65 void buildPageAddOn( Map<String, Object> model, String strResourceType, int nIdResource, String strPortletId,
66 HttpServletRequest request );
67 }