// license-header java merge-point
   //
   // Attention: Generated code! Do not modify by hand!
   // Generated by: SpringDao.vsl in andromda-spring-cartridge.
   //
   package fr.ifremer.quadrige2.core.dao.system.extraction;
   
   /*-
    * #%L
   * Quadrige2 Core :: Server API
   * %%
   * Copyright (C) 2017 Ifremer
   * %%
   * This program is free software: you can redistribute it and/or modify
   * it under the terms of the GNU Affero General Public License as published by
   * the Free Software Foundation, either version 3 of the License, or
   * (at your option) any later version.
   * 
   * This program is distributed in the hope that it will be useful,
   * but WITHOUT ANY WARRANTY; without even the implied warranty of
   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   * GNU General Public License for more details.
   * 
   * You should have received a copy of the GNU Affero General Public License
   * along with this program.  If not, see <http://www.gnu.org/licenses/>.
   * #L%
   */
  
  import fr.ifremer.quadrige2.core.dao.Search;
  import fr.ifremer.quadrige2.core.dao.referential.ObjectType;
  import java.sql.Timestamp;
  import java.util.Collection;
  import java.util.Set;
  import org.andromda.spring.PaginationResult;
  
  /**
   * Liste des champs devant être affichés lors de l'extraction d'un objet.
   * @see ExtractField
   */
  public interface ExtractFieldDao
  {
      /**
       * 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 ExtractField}
       * 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 Collection<?> results);
  
      /**
       * Gets an instance of ExtractField from the persistent store.
       * @param extractFieldId
       * @return ExtractField
       */
      public ExtractField get(Integer extractFieldId);
  
      /**
       * <p>
       * Does the same thing as {@link #get(Integer)} 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 extractFieldId the identifier of the entity to get.
       * @return either the entity or the object transformed from the entity.
       */
      public Object get(int transform, Integer extractFieldId);
  
      /**
       * Loads an instance of ExtractField from the persistent store.
       * @param extractFieldId
       * @return ExtractField
       */
      public ExtractField load(Integer extractFieldId);
  
      /**
       * <p>
       * Does the same thing as {@link #load(Integer)} 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 extractFieldId the identifier of the entity to load.
      * @return either the entity or the object transformed from the entity.
      */
     public Object load(int transform, Integer extractFieldId);
 
     /**
      * Loads all entities of type {@link ExtractField}.
      *
      * @return the loaded entities.
      */
     public Collection<ExtractField> 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 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 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 Collection<?> loadAll(final int transform, final int pageNumber, final int pageSize);
 
     /**
      * Creates an instance of ExtractField and adds it to the persistent store.
      * @param extractField
      * @return ExtractField
      */
     public ExtractField create(ExtractField extractField);
 
     /**
      * <p>
      * Does the same thing as {@link #create(ExtractField)} 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 extractField
      * @return Object
      */
     public Object create(int transform, ExtractField extractField);
 
     /**
      * Creates a new instance of ExtractField and adds
      * from the passed in <code>entities</code> collection
      *
      * @param entities the collection of ExtractField
      * instances to create.
      *
      * @return the created instances.
      */
     public Collection<ExtractField> create(Collection<ExtractField> entities);
 
     /**
      * <p>
      * Does the same thing as {@link #create(ExtractField)} 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 Collection<?> create(int transform, Collection<ExtractField> entities);
 
     /**
      * <p>
      * Creates a new <code>ExtractField</code>
      * instance from <strong>all</strong> attributes and adds it to
      * the persistent store.
      * </p>
      * @param extractFieldNm Nom du champ à afficher
      * @param extractFieldRank Rang du champ pour l'affichage et lors des tri
      * @param extractFieldSortType Type de tri utilisé pour le champ, ASC ou DESC ou NULL
      * @param updateDt Date de modification de l'objet, mise à jour par le système
      * @return ExtractField
      */
     public ExtractField create(
         String extractFieldNm,
         Double extractFieldRank,
         String extractFieldSortType,
         Timestamp updateDt);
 
     /**
      * <p>
      * Does the same thing as {@link #create(String, Double, String, Timestamp)} 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 extractFieldNm Nom du champ à afficher
      * @param extractFieldRank Rang du champ pour l'affichage et lors des tri
      * @param extractFieldSortType Type de tri utilisé pour le champ, ASC ou DESC ou NULL
      * @param updateDt Date de modification de l'objet, mise à jour par le système
      * @return ExtractField
      */
     public Object create(
         int transform,
         String extractFieldNm,
         Double extractFieldRank,
         String extractFieldSortType,
         Timestamp updateDt);
 
     /**
      * <p>
      * Creates a new <code>ExtractField</code>
      * instance from only <strong>required</strong> properties (attributes
      * and association ends) and adds it to the persistent store.
      * </p>
      * @param extractFieldNm
      * @param extractFieldRank
      * @param updateDt
      * @param extractFilter
      * @param objectType
      * @return ExtractField
      */
     public ExtractField create(
         String extractFieldNm,
         Double extractFieldRank,
         Timestamp updateDt,
         ExtractFilter extractFilter,
         ObjectType objectType);
 
     /**
      * <p>
      * Does the same thing as {@link #create(String, Double, Timestamp)} 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 extractFieldNm
      * @param extractFieldRank
      * @param updateDt
      * @param extractFilter
      * @param objectType
      * @return Object
      */
     public Object create(
         int transform,
         String extractFieldNm,
         Double extractFieldRank,
         Timestamp updateDt,
         ExtractFilter extractFilter,
         ObjectType objectType);
 
     /**
      * Updates the <code>extractField</code> instance in the persistent store.
      * @param extractField
      */
     public void update(ExtractField extractField);
 
     /**
      * Updates all instances in the <code>entities</code> collection in the persistent store.
      * @param entities
      */
     public void update(Collection<ExtractField> entities);
 
     /**
      * Removes the instance of ExtractField from the persistent store.
      * @param extractField
      */
     public void remove(ExtractField extractField);
 
     /**
      * Removes the instance of ExtractField having the given
      * <code>identifier</code> from the persistent store.
      * @param extractFieldId
      */
     public void remove(Integer extractFieldId);
 
     /**
      * Removes all entities in the given <code>entities</code> collection.
      * @param entities
      */
     public void remove(Collection<ExtractField> entities);
 
 
     /**
      * Does the same thing as {@link #search(int, 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 PaginationResult} instance.
      */
     public PaginationResult search(final int transform, final int pageNumber, final int pageSize, final Search search);
 
     /**
      * Does the same thing as {@link #search(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 PaginationResult} instance.
      */
     public PaginationResult search(final int pageNumber, final int pageSize, final Search search);
 
     /**
      * Does the same thing as {@link #search(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 Set<?> search(final int transform, final 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 Set<ExtractField> search(final 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>fr.ifremer.quadrige2.core.dao.system.extraction.ExtractFieldDao</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 fr.ifremer.quadrige2.core.dao.system.extraction.ExtractFieldDao}
      * @param entity an entity that was found
      * @return the transformed entity (i.e. new value object, etc)
      * @see #transformEntities(int,Collection)
      */
     public Object transformEntity(final int transform, final ExtractField entity);
 
     /**
      * Transforms a collection of entities using the
      * {@link #transformEntity(int,ExtractField)}
      * 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>fr.ifremer.quadrige2.core.dao.system.extraction.ExtractFieldDao</code>
      * @param entities the collection of entities to transform
      * @see #transformEntity(int,ExtractField)
      */
     public void transformEntities(final int transform, final Collection<?> entities);
 
     // spring-dao merge-point
 }