/**
 * Example license header for Java files
 *
 *      http://andromda.sourceforge.net/
 */
//
// Attention: Generated code! Do not modify by hand!
// Generated by SpringDao.vsl in andromda-spring-cartridge on 09/18/2014 17:02:24-0400. Do not modify by hand!.
//
package org.andromda.test.3;

/**
 * TODO: Model Documentation for org.andromda.test.3.Car
 * @see org.andromda.test.3.Car
 */
public interface CarDao
{
    /**
     * This constant is used as a transformation flag; entities can be converted automatically into value objects
     * or other types, different methods in a class implementing this interface support this feature: look for
     * an <code>int</code> parameter called <code>transform</code>.
     * <p>
     * This specific flag denotes no transformation will occur.
     */
    public static final int TRANSFORM_NONE = 0;


    /**
     * Transforms the given results to a collection of {@link org.andromda.test.3.Car}
     * instances (this is useful when the returned results contains a row of data and you want just entities only).
     *
     * @param results the query results.
     */
    public void toEntities(final java.util.Collection<?> results);

    /**
     * Gets an instance of org.andromda.test.3.Car from the persistent store.
     * @param id
     * @return org.andromda.test.3.Car
     */
    public org.andromda.test.3.Car get(java.lang.Long id);

    /**
     * <p>
     * Does the same thing as {@link #get(java.lang.Long)} with an
     * additional flag called <code>transform</code>. If this flag is set to <code>TRANSFORM_NONE</code> then
     * the returned entity will <strong>NOT</strong> be transformed. If this flag is any of the other constants
     * defined in this class then the result <strong>WILL BE</strong> passed through an operation which can
     * optionally transform the entity (into a value object for example). By default, transformation does
     * not occur.
     * </p>
     *
     * @param transform flag to determine transformation type.
     * @param id the identifier of the entity to get.
     * @return either the entity or the object transformed from the entity.
     */
    public Object get(int transform, java.lang.Long id);

    /**
     * Loads an instance of org.andromda.test.3.Car from the persistent store.
     * @param id
     * @return org.andromda.test.3.Car
     */
    public org.andromda.test.3.Car load(java.lang.Long id);

    /**
     * <p>
     * Does the same thing as {@link #load(java.lang.Long)} with an
     * additional flag called <code>transform</code>. If this flag is set to <code>TRANSFORM_NONE</code> then
     * the returned entity will <strong>NOT</strong> be transformed. If this flag is any of the other constants
     * defined in this class then the result <strong>WILL BE</strong> passed through an operation which can
     * optionally transform the entity (into a value object for example). By default, transformation does
     * not occur.
     * </p>
     *
     * @param transform flag to determine transformation type.
     * @param id the identifier of the entity to load.
     * @return either the entity or the object transformed from the entity.
     */
    public Object load(int transform, java.lang.Long id);

    /**
     * Loads all entities of type {@link org.andromda.test.3.Car}.
     *
     * @return the loaded entities.
     */
    public java.util.Collection<org.andromda.test.3.Car> loadAll();

    /**
     * <p>
     * Does the same thing as {@link #loadAll()} with an
     * additional flag called <code>transform</code>. If this flag is set to <code>TRANSFORM_NONE</code> then
     * the returned entity will <strong>NOT</strong> be transformed. If this flag is any of the other constants
     * defined here then the result <strong>WILL BE</strong> passed through an operation which can optionally
     * transform the entity (into a value object for example). By default, transformation does
     * not occur.
     * </p>
     *
     * @param transform the flag indicating what transformation to use.
     * @return the loaded entities.
     */
    public java.util.Collection<?> loadAll(final int transform);

    /**
     * <p>
     * Does the same thing as {@link #loadAll()} with an
     * additional two arguments called <code>pageNumber</code> and <code>pageSize</code>. The <code>pageNumber</code>
     * argument allows you to specify the page number when you are paging the results and the pageSize allows you to specify the size of the
     * page retrieved.
     * </p>
     *
     * @param pageNumber the page number to retrieve when paging results.
     * @param pageSize the size of the page to retrieve when paging results.
     * @return the loaded entities.
     */
    public java.util.Collection<?> loadAll(final int pageNumber, final int pageSize);

    /**
     * <p>
     * Does the same thing as {@link #loadAll(int)} with an
     * additional two arguments called <code>pageNumber</code> and <code>pageSize</code>. The <code>pageNumber</code>
     * argument allows you to specify the page number when you are paging the results and the pageSize allows you to specify the size of the
     * page retrieved.
     * </p>
     *
     * @param transform the flag indicating what transformation to use.
     * @param pageNumber the page number to retrieve when paging results.
     * @param pageSize the size of the page to retrieve when paging results.
     * @return the loaded entities.
     */
    public java.util.Collection<?> loadAll(final int transform, final int pageNumber, final int pageSize);

    /**
     * Creates an instance of org.andromda.test.3.Car and adds it to the persistent store.
     * @param car
     * @return org.andromda.test.3.Car
     */
    public org.andromda.test.3.Car create(org.andromda.test.3.Car car);

    /**
     * <p>
     * Does the same thing as {@link #create(org.andromda.test.3.Car)} with an
     * additional flag called <code>transform</code>. If this flag is set to <code>TRANSFORM_NONE</code> then
     * the returned entity will <strong>NOT</strong> be transformed. If this flag is any of the other constants
     * defined here then the result <strong>WILL BE</strong> passed through an operation which can optionally
     * transform the entity (into a value object for example). By default, transformation does
     * not occur.
     * </p>
     * @param transform
     * @param car
     * @return Object
     */
    public Object create(int transform, org.andromda.test.3.Car car);

    /**
     * Creates a new instance of org.andromda.test.3.Car and adds
     * from the passed in <code>entities</code> collection
     *
     * @param entities the collection of org.andromda.test.3.Car
     * instances to create.
     *
     * @return the created instances.
     */
    public java.util.Collection<org.andromda.test.3.Car> create(java.util.Collection<org.andromda.test.3.Car> entities);

    /**
     * <p>
     * Does the same thing as {@link #create(org.andromda.test.3.Car)} with an
     * additional flag called <code>transform</code>. If this flag is set to <code>TRANSFORM_NONE</code> then
     * the returned entity will <strong>NOT</strong> be transformed. If this flag is any of the other constants
     * defined here then the result <strong>WILL BE</strong> passed through an operation which can optionally
     * transform the entities (into value objects for example). By default, transformation does
     * not occur.
     * </p>
     * @param transform
     * @param entities
     * @return Collection
     */
    public java.util.Collection<?> create(int transform, java.util.Collection<org.andromda.test.3.Car> entities);

    /**
     * <p>
     * Creates a new <code>org.andromda.test.3.Car</code>
     * instance from <strong>all</strong> attributes and adds it to
     * the persistent store.
     * </p>
     * @param serial TODO: Model Documentation for org.andromda.test.3.Car.serial
     * @param name TODO: Model Documentation for org.andromda.test.3.Car.name
     * @param type TODO: Model Documentation for org.andromda.test.3.Car.type
     * @return org.andromda.test.3.Car
     */
    public org.andromda.test.3.Car create(
        java.lang.String serial,
        java.lang.String name,
        java.lang.String type);

    /**
     * <p>
     * Does the same thing as {@link #create(java.lang.String, java.lang.String, java.lang.String)} with an
     * additional flag called <code>transform</code>. If this flag is set to <code>TRANSFORM_NONE</code> then
     * the returned entity will <strong>NOT</strong> be transformed. If this flag is any of the other constants
     * defined here then the result <strong>WILL BE</strong> passed through an operation which can optionally
     * transform the entity (into a value object for example). By default, transformation does
     * not occur.
     * </p>
     * @param transform
     * @param serial TODO: Model Documentation for org.andromda.test.3.Car.serial
     * @param name TODO: Model Documentation for org.andromda.test.3.Car.name
     * @param type TODO: Model Documentation for org.andromda.test.3.Car.type
     * @return org.andromda.test.3.Car
     */
    public Object create(
        int transform,
        java.lang.String serial,
        java.lang.String name,
        java.lang.String type);

    /**
     * <p>
     * Creates a new <code>org.andromda.test.3.Car</code>
     * instance from only <strong>required</strong> properties (attributes
     * and association ends) and adds it to the persistent store.
     * </p>
     * @param name
     * @param owner
     * @param serial
     * @param type
     * @return org.andromda.test.3.Car
     */
    public org.andromda.test.3.Car create(
        java.lang.String name,
        org.andromda.test.3.Person owner,
        java.lang.String serial,
        java.lang.String type);

    /**
     * <p>
     * Does the same thing as {@link #create(java.lang.String, java.lang.String, java.lang.String)} with an
     * additional flag called <code>transform</code>. If this flag is set to <code>TRANSFORM_NONE</code> then
     * the returned entity will <strong>NOT</strong> be transformed. If this flag is any of the other constants
     * defined here then the result <strong>WILL BE</strong> passed through an operation which can optionally
     * transform the entity (into a value object for example). By default, transformation does
     * not occur.
     * </p>
     * @param transform flag to determine transformation type.
     * @param name
     * @param owner
     * @param serial
     * @param type
     * @return Object
     */
    public Object create(
        int transform,
        java.lang.String name,
        org.andromda.test.3.Person owner,
        java.lang.String serial,
        java.lang.String type);

    /**
     * Updates the <code>car</code> instance in the persistent store.
     * @param car
     */
    public void update(org.andromda.test.3.Car car);

    /**
     * Create or Update the <code>car</code> instance in the persistent store.
     * @param car
     * @return org.andromda.test.3.Car
     */
    public org.andromda.test.3.Car createOrUpdate(org.andromda.test.3.Car car);

    /**
     * Updates all instances in the <code>entities</code> collection in the persistent store.
     * @param entities
     */
    public void update(java.util.Collection<org.andromda.test.3.Car> entities);

    /**
     * Removes the instance of org.andromda.test.3.Car from the persistent store.
     * @param car
     */
    public void remove(org.andromda.test.3.Car car);

    /**
     * Removes the instance of org.andromda.test.3.Car having the given
     * <code>identifier</code> from the persistent store.
     * @param id
     */
    public void remove(java.lang.Long id);

    /**
     * Removes all entities in the given <code>entities</code> collection.
     * @param entities
     */
    public void remove(java.util.Collection<org.andromda.test.3.Car> entities);

    /**
     * Returns true if all cars are currently rented.
     * @return boolean
     */
    public boolean allCarsAreRented();


    /**
     * Does the same thing as {@link #search(int, org.andromda.spring.Search)} but with an
     * additional two flags called <code>pageNumber</code> and <code>pageSize</code>. These flags allow you to
     * limit your data to a specified page number and size.
     *
     * @param transform the transformation flag.
     * @param pageNumber the page number in the data to retrieve
     * @param pageSize the size of the page to retrieve.
     * @param search the search object which provides the search parameters and pagination specification.
     * @return any found results from the search wrapped in a {@link org.andromda.spring.PaginationResult} instance.
     */
    public org.andromda.spring.PaginationResult search(final int transform, final int pageNumber, final int pageSize, final org.andromda.spring.Search search);

    /**
     * Does the same thing as {@link #search(org.andromda.spring.Search)} but with an
     * additional two flags called <code>pageNumber</code> and <code>pageSize</code>. These flags allow you to
     * limit your data to a specified page number and size.
     *
     * @param pageNumber the page number in the data to retrieve
     * @param pageSize the size of the page to retrieve.
     * @param search the search object which provides the search parameters and pagination specification.
     * @return any found results from the search wrapped in a {@link org.andromda.spring.PaginationResult} instance.
     */
    public org.andromda.spring.PaginationResult search(final int pageNumber, final int pageSize, final org.andromda.spring.Search search);

    /**
     * Does the same thing as {@link #search(org.andromda.spring.Search)} but with an
     * additional flag called <code>transform</code>. If this flag is set to <code>TRANSFORM_NONE</code> then
     * finder results will <strong>NOT</strong> be transformed during retrieval.
     * If this flag is any of the other constants defined here
     * then results <strong>WILL BE</strong> passed through an operation which can optionally
     * transform the entities (into value objects for example). By default, transformation does
     * not occur.
     *
     * @param transform the transformation flag.
     * @param search the search object which provides the search parameters and pagination specification.
     * @return any found results from the search.
     */
    public java.util.Collection<?> search(final int transform, final org.andromda.spring.Search search);

    /**
     * Performs a search using the parameters specified in the given <code>search</code> object.
     *
     * @param search the search object which provides the search parameters and pagination specification.
     * @return any found results from the search.
     */
    public java.util.Collection<org.andromda.test.3.Car> search(final org.andromda.spring.Search search);

    /**
     * Allows transformation of entities into value objects
     * (or something else for that matter), when the <code>transform</code>
     * flag is set to one of the constants defined in <code>org.andromda.test.3.CarDao</code>, please note
     * that the {@link #TRANSFORM_NONE} constant denotes no transformation, so the entity itself
     * will be returned.
     *
     * If the integer argument value is unknown {@link #TRANSFORM_NONE} is assumed.
     *
     * @param transform one of the constants declared in {@link org.andromda.test.3.CarDao}
     * @param entity an entity that was found
     * @return the transformed entity (i.e. new value object, etc)
     * @see #transformEntities(int,java.util.Collection)
     */
    public Object transformEntity(final int transform, final org.andromda.test.3.Car entity);

    /**
     * Transforms a collection of entities using the
     * {@link #transformEntity(int,org.andromda.test.3.Car)}
     * method. This method does not instantiate a new collection.
     * <p>
     * This method is to be used internally only.
     *
     * @param transform one of the constants declared in <code>org.andromda.test.3.CarDao</code>
     * @param entities the collection of entities to transform
     * @see #transformEntity(int,org.andromda.test.3.Car)
     */
    public void transformEntities(final int transform, final java.util.Collection<?> entities);

    /**
     * Searches for a single instance of org.andromda.test.3.Car.
     * @param serial the unique serial to be used in the search.'
     * @return a single instance of org.andromda.test.3.Car.
     */
    public org.andromda.test.3.Car searchUniqueSerial(final java.lang.String serial);

    /**
     * Searches for a single instance of org.andromda.test.3.Car.
     * @param transform the transformation flag.
     * @param serial the unique serial to be used in the search.
     * @return a value object according the transformation flag.
     */
    public Object searchUniqueSerial(final int transform, final java.lang.String serial);

    /**
     * Searches for a single instance of org.andromda.test.3.Car.
     * @param name the unique name to be used in the search.'
     * @return a single instance of org.andromda.test.3.Car.
     */
    public org.andromda.test.3.Car searchUniqueName(final java.lang.String name);

    /**
     * Searches for a single instance of org.andromda.test.3.Car.
     * @param transform the transformation flag.
     * @param name the unique name to be used in the search.
     * @return a value object according the transformation flag.
     */
    public Object searchUniqueName(final int transform, final java.lang.String name);

    /**
     * Searches for a single instance of org.andromda.test.3.Car.
     * @param type the unique type to be used in the search.'
     * @return a single instance of org.andromda.test.3.Car.
     */
    public org.andromda.test.3.Car searchUniqueType(final java.lang.String type);

    /**
     * Searches for a single instance of org.andromda.test.3.Car.
     * @param transform the transformation flag.
     * @param type the unique type to be used in the search.
     * @return a value object according the transformation flag.
     */
    public Object searchUniqueType(final int transform, final java.lang.String type);


    // spring-dao merge-point
}