IExtendableResourceActionHitListener.java

/*
 * Copyright (c) 2002-2016, Mairie de Paris
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 *  1. Redistributions of source code must retain the above copyright notice
 *     and the following disclaimer.
 *
 *  2. Redistributions in binary form must reproduce the above copyright notice
 *     and the following disclaimer in the documentation and/or other materials
 *     provided with the distribution.
 *
 *  3. Neither the name of 'Mairie de Paris' nor 'Lutece' nor the names of its
 *     contributors may be used to endorse or promote products derived from
 *     this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 * License 1.0
 */
package fr.paris.lutece.portal.service.resource;

import java.util.Map;

/**
 * Listener for extendable resource action hit
 */
public interface IExtendableResourceActionHitListener
{
    /**
     * Get the total number of hit associated to a given action name and resource type
     * 
     * @param strActionName
     *            The name of the action to get the number of hit of
     * @param strExtendableResourceType
     *            The resource type to get the hit of
     * @return The number of hit, or 0 if this action has no hit for this resource type
     */
    int getActionHit( String strActionName, String strExtendableResourceType );

    /**
     * Get the list of action names associated with a number of hit for a given resource
     * 
     * @param strExtendableResourceId
     *            The id of the resource
     * @param strExtendableResourceType
     *            The type of the resource
     * @return A map containing associations between action names and hit number
     */
    Map<String, Integer> getResourceHit( String strExtendableResourceId, String strExtendableResourceType );

    /**
     * Get the number of hit associated with a resource and an action name
     * 
     * @param strExtendableResourceId
     *            The id of the resource
     * @param strExtendableResourceType
     *            The type of the resource
     * @param strActionName
     *            The name of the action
     * @return The number of hit, or 0 if the resource has no hit for this action
     */
    int getResourceActionHit( String strExtendableResourceId, String strExtendableResourceType, String strActionName );

    /**
     * Notify this listener that an action has been performed on a resource
     * 
     * @param strExtendableResourceId
     *            The id of the resource the action was performed on
     * @param strExtendableResourceType
     *            The type of the resource the action was performed on
     * @param strActionName
     *            The name of the action that was performed on the resource
     */
    void notifyActionOnResource( String strExtendableResourceId, String strExtendableResourceType, String strActionName );
}