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.service.resource;
35
36 import java.util.Map;
37
38
39 /**
40 * Listener for extendable resource action hit
41 */
42 public interface IExtendableResourceActionHitListener
43 {
44 /**
45 * Get the total number of hit associated to a given action name and
46 * resource type
47 * @param strActionName The name of the action to get the number of hit of
48 * @param strExtendableResourceType The resource type to get the hit of
49 * @return The number of hit, or 0 if this action has no hit for this
50 * resource type
51 */
52 int getActionHit( String strActionName, String strExtendableResourceType );
53
54 /**
55 * Get the list of action names associated with a number of hit for a given
56 * resource
57 * @param strExtendableResourceId The id of the resource
58 * @param strExtendableResourceType The type of the resource
59 * @return A map containing associations between action names and hit number
60 */
61 Map<String, Integer> getResourceHit( String strExtendableResourceId, String strExtendableResourceType );
62
63 /**
64 * Get the number of hit associated with a resource and an action name
65 * @param strExtendableResourceId The id of the resource
66 * @param strExtendableResourceType The type of the resource
67 * @param strActionName The name of the action
68 * @return The number of hit, or 0 if the resource has no hit for this
69 * action
70 */
71 int getResourceActionHit( String strExtendableResourceId, String strExtendableResourceType, String strActionName );
72
73 /**
74 * Notify this listener that an action has been performed on a resource
75 * @param strExtendableResourceId The id of the resource the action was
76 * performed on
77 * @param strExtendableResourceType The type of the resource the action was
78 * performed on
79 * @param strActionName The name of the action that was performed on the
80 * resource
81 */
82 void notifyActionOnResource( String strExtendableResourceId, String strExtendableResourceType, String strActionName );
83 }