/*
 * Copyright (c) 2002-2007, 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 ${businessObject.packageName};

import java.util.Collection;


 /**
 * I${businessObject.className}DAO Interface
 */

public interface I${businessObject.className}DAO
{


    /**
     * Insert a new record in the table.
     * @param ${businessObject.instanceName} instance of the ${businessObject.className} object to inssert
     */

    void insert( ${businessObject.className} ${businessObject.instanceName} );



     /**
     * Update the record in the table
     * 
     * @param ${businessObject.instanceName} the reference of the ${businessObject.className}
     */

    void store( ${businessObject.className} ${businessObject.instanceName} );


    /**
     * Delete a record from the table
     * 
     * @param nId${businessObject.className} int identifier of the ${businessObject.className} to delete
     */

    void delete( int nId${businessObject.className} );

    ///////////////////////////////////////////////////////////////////////////
    // Finders

    /**
     * load the data of the right from the table
     * 
     * @param nKey The identifier of the ${businessObject.instanceName}
     * @return The instance of the ${businessObject.instanceName}
     */

    ${businessObject.className} load( int nKey );



     /**
     * Loads the data of all the ${businessObject.instanceName}s and returns them in form of a collection
     * 
     * @return the collection which contains the data of all the ${businessObject.instanceName}s
     */

    Collection<${businessObject.className}> select${businessObject.className}sList();
    
}