CRMUserAttributeHome.java

/*
 * Copyright (c) 2002-2014, 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.plugins.crm.business.user;

import fr.paris.lutece.plugins.crm.service.CRMPlugin;
import fr.paris.lutece.portal.service.plugin.Plugin;
import fr.paris.lutece.portal.service.plugin.PluginService;
import fr.paris.lutece.portal.service.spring.SpringContextService;

import java.util.Map;

/**
 *
 * CRMUserAttributeHome
 *
 */
public final class CRMUserAttributeHome
{
    private static final String BEAN_CRM_CRMUSERATTRIBUTEDAO = "crm.crmUserAttributeDAO";
    private static Plugin _plugin = PluginService.getPlugin( CRMPlugin.PLUGIN_NAME );
    private static ICRMUserAttributeDAO _dao = SpringContextService.getBean( BEAN_CRM_CRMUSERATTRIBUTEDAO );

    /**
     * Private constructor - this class need not be instantiated
     */
    private CRMUserAttributeHome( )
    {
    }

    /**
     * Insert a new record in the table.
     * 
     * @param nIdCRMUser
     *            the id crm user
     * @param strUserAttributeKey
     *            user attribute key
     * @param strUserAttributeValue
     *            user attribute value
     */
    public static void create( int nIdCRMUser, String strUserAttributeKey, String strUserAttributeValue )
    {
        _dao.insert( nIdCRMUser, strUserAttributeKey, strUserAttributeValue, _plugin );
    }

    /**
     * Delete a record from the table
     * 
     * @param nIdCRMUser
     *            int identifier of the CRMUser to delete
     */
    public static void remove( int nIdCRMUser )
    {
        _dao.delete( nIdCRMUser, _plugin );
    }

    /**
     * Load the data from the table
     * 
     * @param nIdCRMUser
     *            The identifier of the CRMUser
     * @return The user attributes
     */
    public static Map<String, String> findByPrimaryKey( int nIdCRMUser )
    {
        return _dao.load( nIdCRMUser, _plugin );
    }

    /**
     * Count the number of instance of a given value of an attribute
     * 
     * @param strUserAttributeValue
     *            The value of the attribute
     * @param strUserAttributeKey
     *            The key of the attribute
     * @return The number of instances of attributes with the given value for the given attribute key.
     */
    public static int countAttributeValueInstances( String strUserAttributeValue, String strUserAttributeKey )
    {
        return _dao.countAttributeValueInstances( strUserAttributeValue, strUserAttributeKey, _plugin );
    }
}