// license-header java merge-point
   //
   // Attention: Generated code! Do not modify by hand!
   // Generated by: SpringDao.vsl in andromda-spring-cartridge.
   //
   package fr.ifremer.quadrige3.core.dao.administration.user;
   
   /*-
    * #%L
   * Quadrige3 Core :: Client API
   * %%
   * Copyright (C) 2017 - 2024 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.quadrige3.core.dao.Search;
  import fr.ifremer.quadrige3.core.dao.referential.Status;
  import fr.ifremer.quadrige3.core.vo.administration.user.LightQuserVO;
  import fr.ifremer.quadrige3.core.vo.administration.user.QuserVO;
  import java.sql.Timestamp;
  import java.util.Collection;
  import java.util.Date;
  import java.util.Set;
  import org.andromda.spring.PaginationResult;
  
  /**
   * Liste l'ensemble des agents et utilisateurs du système.
   * @see Quser
   */
  public interface QuserDao
  {
      /**
       * 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 Quser}
       * 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);
  
      /**
       * 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 entities must be transformed into objects of type
       * {@link QuserVO}.
       */
      public static final int TRANSFORM_QUSERVO = 1;
  
      /**
       * Copies the fields of the specified entity to the target value object. This method is similar to
       * toQuserVO(), but it does not handle any attributes in the target
       * value object that are "read-only" (as those do not have setter methods exposed).
       * @param source
       * @param target
       */
      public void toQuserVO(
          Quser source,
          QuserVO target);
  
      /**
       * Converts this DAO's entity to an object of type {@link QuserVO}.
       * @param entity
       * @return QuserVO
       */
      public QuserVO toQuserVO(Quser entity);
  
      /**
       * Converts this DAO's entity to a Collection of instances of type {@link QuserVO}.
       * @param entities
       */
      public Collection<QuserVO> toQuserVOCollection(Collection<?> entities);
  
      /**
       * Converts this DAO's entity to an array of instances of type {@link QuserVO}.
       * @param entities
       * @return QuserVO[]
      */
     public QuserVO[] toQuserVOArray(Collection<?> entities);
 
     /**
      * Copies the fields of {@link QuserVO} to the specified entity.
      * @param source
      * @param target
      * @param copyIfNull If FALSE, the value object's field will not be copied to the entity if the value is NULL. If TRUE,
      * it will be copied regardless of its value.
      */
     public void quserVOToEntity(
         QuserVO source,
         Quser target,
         boolean copyIfNull);
 
     /**
      * Converts an instance of type {@link QuserVO} to this DAO's entity.
      * @param quserVO
      * @return Quser
      */
     public Quser quserVOToEntity(QuserVO quserVO);
 
     /**
      * Converts a Collection of instances of type {@link QuserVO} to this
      * DAO's entity.
      * @param instances
      */
     public void quserVOToEntityCollection(Collection<?> instances);
 
     /**
      * 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 entities must be transformed into objects of type
      * {@link LightQuserVO}.
      */
     public static final int TRANSFORM_LIGHTQUSERVO = 2;
 
     /**
      * Copies the fields of the specified entity to the target value object. This method is similar to
      * toLightQuserVO(), but it does not handle any attributes in the target
      * value object that are "read-only" (as those do not have setter methods exposed).
      * @param source
      * @param target
      */
     public void toLightQuserVO(
         Quser source,
         LightQuserVO target);
 
     /**
      * Converts this DAO's entity to an object of type {@link LightQuserVO}.
      * @param entity
      * @return LightQuserVO
      */
     public LightQuserVO toLightQuserVO(Quser entity);
 
     /**
      * Converts this DAO's entity to a Collection of instances of type {@link LightQuserVO}.
      * @param entities
      */
     public Collection<LightQuserVO> toLightQuserVOCollection(Collection<?> entities);
 
     /**
      * Converts this DAO's entity to an array of instances of type {@link LightQuserVO}.
      * @param entities
      * @return LightQuserVO[]
      */
     public LightQuserVO[] toLightQuserVOArray(Collection<?> entities);
 
     /**
      * Copies the fields of {@link LightQuserVO} to the specified entity.
      * @param source
      * @param target
      * @param copyIfNull If FALSE, the value object's field will not be copied to the entity if the value is NULL. If TRUE,
      * it will be copied regardless of its value.
      */
     public void lightQuserVOToEntity(
         LightQuserVO source,
         Quser target,
         boolean copyIfNull);
 
     /**
      * Converts an instance of type {@link LightQuserVO} to this DAO's entity.
      * @param lightQuserVO
      * @return Quser
      */
     public Quser lightQuserVOToEntity(LightQuserVO lightQuserVO);
 
     /**
      * Converts a Collection of instances of type {@link LightQuserVO} to this
      * DAO's entity.
      * @param instances
      */
     public void lightQuserVOToEntityCollection(Collection<?> instances);
 
     /**
      * Gets an instance of Quser from the persistent store.
      * @param quserId
      * @return Quser
      */
     public Quser get(Integer quserId);
 
     /**
      * <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 quserId the identifier of the entity to get.
      * @return either the entity or the object transformed from the entity.
      */
     public Object get(int transform, Integer quserId);
 
     /**
      * Loads an instance of Quser from the persistent store.
      * @param quserId
      * @return Quser
      */
     public Quser load(Integer quserId);
 
     /**
      * <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 quserId the identifier of the entity to load.
      * @return either the entity or the object transformed from the entity.
      */
     public Object load(int transform, Integer quserId);
 
     /**
      * Loads all entities of type {@link Quser}.
      *
      * @return the loaded entities.
      */
     public Collection<Quser> 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 Quser and adds it to the persistent store.
      * @param quser
      * @return Quser
      */
     public Quser create(Quser quser);
 
     /**
      * <p>
      * Does the same thing as {@link #create(Quser)} 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 quser
      * @return Object
      */
     public Object create(int transform, Quser quser);
 
     /**
      * Creates a new instance of Quser and adds
      * from the passed in <code>entities</code> collection
      *
      * @param entities the collection of Quser
      * instances to create.
      *
      * @return the created instances.
      */
     public Collection<Quser> create(Collection<Quser> entities);
 
     /**
      * <p>
      * Does the same thing as {@link #create(Quser)} 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<Quser> entities);
 
     /**
      * <p>
      * Creates a new <code>Quser</code>
      * instance from <strong>all</strong> attributes and adds it to
      * the persistent store.
      * </p>
      * @param quserCd Matricule : identifie de manière unique une personne dans LDAP, attribut obligatoire dans LDAP
      * @param quserLastNm Nom de l'agent, obligatoire
      * @param quserFirstNm Prénom de l'agent
      * @param quserIntranetLg UID du LDAP intranet de l'agent s'il existe
      * @param quserExtranetLg UID du LDAP extranet de l'agent s'il existe
      * @param quserEMail Adresse électronique de la personne
      * @param quserAddress Adresse du site dans le LDAP, ou informations sur l'adresse de l'utilisateur.
      * @param quserPhone Liste des téléphones de la personnes
      * @param quserOrgan Organisme dont dépend la personne (voir avec service)!!!
      * @param quserAdminCenter Centre administratif dont dépend la personne (voir avec service) !!
      * @param quserSite Site auquel est affectée la personne
      * @param quserLdapPresent Oui, si l'utilisateur est présent dans le LDAP (code renseigné).
      * @param quserCryptPassword Crypt password, for local DB only (e.g. ReefDb)
      * @param quserCreationDt Date de création de l'objet
      * @param updateDt Date de modification de l'objet
      * @param quserCm 
      * @return Quser
      */
     public Quser create(
         String quserCd,
         String quserLastNm,
         String quserFirstNm,
         String quserIntranetLg,
         String quserExtranetLg,
         String quserEMail,
         String quserAddress,
         String quserPhone,
         String quserOrgan,
         String quserAdminCenter,
         String quserSite,
         String quserLdapPresent,
         String quserCryptPassword,
         Date quserCreationDt,
         Timestamp updateDt,
         String quserCm);
 
     /**
      * <p>
      * Does the same thing as {@link #create(String, String, String, String, String, String, String, String, String, String, String, String, String, Date, Timestamp, 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 quserCd Matricule : identifie de manière unique une personne dans LDAP, attribut obligatoire dans LDAP
      * @param quserLastNm Nom de l'agent, obligatoire
      * @param quserFirstNm Prénom de l'agent
      * @param quserIntranetLg UID du LDAP intranet de l'agent s'il existe
      * @param quserExtranetLg UID du LDAP extranet de l'agent s'il existe
      * @param quserEMail Adresse électronique de la personne
      * @param quserAddress Adresse du site dans le LDAP, ou informations sur l'adresse de l'utilisateur.
      * @param quserPhone Liste des téléphones de la personnes
      * @param quserOrgan Organisme dont dépend la personne (voir avec service)!!!
      * @param quserAdminCenter Centre administratif dont dépend la personne (voir avec service) !!
      * @param quserSite Site auquel est affectée la personne
      * @param quserLdapPresent Oui, si l'utilisateur est présent dans le LDAP (code renseigné).
      * @param quserCryptPassword Crypt password, for local DB only (e.g. ReefDb)
      * @param quserCreationDt Date de création de l'objet
      * @param updateDt Date de modification de l'objet
      * @param quserCm 
      * @return Quser
      */
     public Object create(
         int transform,
         String quserCd,
         String quserLastNm,
         String quserFirstNm,
         String quserIntranetLg,
         String quserExtranetLg,
         String quserEMail,
         String quserAddress,
         String quserPhone,
         String quserOrgan,
         String quserAdminCenter,
         String quserSite,
         String quserLdapPresent,
         String quserCryptPassword,
         Date quserCreationDt,
         Timestamp updateDt,
         String quserCm);
 
     /**
      * <p>
      * Creates a new <code>Quser</code>
      * instance from only <strong>required</strong> properties (attributes
      * and association ends) and adds it to the persistent store.
      * </p>
      * @param quserFirstNm
      * @param quserLastNm
      * @param department
      * @param status
      * @return Quser
      */
     public Quser create(
         String quserFirstNm,
         String quserLastNm,
         Department department,
         Status status);
 
     /**
      * <p>
      * Does the same thing as {@link #create(String, 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 quserFirstNm
      * @param quserLastNm
      * @param department
      * @param status
      * @return Object
      */
     public Object create(
         int transform,
         String quserFirstNm,
         String quserLastNm,
         Department department,
         Status status);
 
     /**
      * Updates the <code>quser</code> instance in the persistent store.
      * @param quser
      */
     public void update(Quser quser);
 
     /**
      * Updates all instances in the <code>entities</code> collection in the persistent store.
      * @param entities
      */
     public void update(Collection<Quser> entities);
 
     /**
      * Removes the instance of Quser from the persistent store.
      * @param quser
      */
     public void remove(Quser quser);
 
     /**
      * Removes the instance of Quser having the given
      * <code>identifier</code> from the persistent store.
      * @param quserId
      */
     public void remove(Integer quserId);
 
     /**
      * Removes all entities in the given <code>entities</code> collection.
      * @param entities
      */
     public void remove(Collection<Quser> 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<Quser> 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.quadrige3.core.dao.administration.user.QuserDao</code>, please note
      * that the {@link #TRANSFORM_NONE} constant denotes no transformation, so the entity itself
      * will be returned.
      * <p>
      * This method will return instances of these types:
      * <ul>
      *   <li>{@link Quser} - {@link #TRANSFORM_NONE}</li>
      *   <li>{@link QuserVO} - {@link #TRANSFORM_QUSERVO}</li>
      *   <li>{@link LightQuserVO} - {@link #TRANSFORM_LIGHTQUSERVO}</li>
      * </ul>
      *
      * If the integer argument value is unknown {@link #TRANSFORM_NONE} is assumed.
      *
      * @param transform one of the constants declared in {@link fr.ifremer.quadrige3.core.dao.administration.user.QuserDao}
      * @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 Quser entity);
 
     /**
      * Transforms a collection of entities using the
      * {@link #transformEntity(int,Quser)}
      * 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.quadrige3.core.dao.administration.user.QuserDao</code>
      * @param entities the collection of entities to transform
      * @see #transformEntity(int,Quser)
      */
     public void transformEntities(final int transform, final Collection<?> entities);
 
     // spring-dao merge-point
 }