package fr.ifremer.dali.dao.administration.program;
   
   /*
    * #%L
    * Dali :: Core
    * $Id:$
    * $HeadURL:$
    * %%
    * Copyright (C) 2014 - 2015 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.dali.dao.referential.monitoringLocation.DaliMonitoringLocationDao;
  import fr.ifremer.quadrige3.core.dao.administration.program.ProgramDao;
  import fr.ifremer.dali.dao.administration.strategy.DaliStrategyDao;
  import fr.ifremer.dali.dto.configuration.programStrategy.ProgramDTO;
  import org.springframework.cache.annotation.CacheEvict;
  import org.springframework.cache.annotation.Cacheable;
  import org.springframework.cache.annotation.Caching;
  
  import java.util.Collection;
  import java.util.Date;
  import java.util.List;
  
  
  /**
   * <p>DaliProgramDao interface.</p>
   *
   */
  public interface DaliProgramDao extends ProgramDao {
  
      /** Constant <code>PROGRAM_BY_CODE_CACHE="programByCode"</code> */
      String PROGRAM_BY_CODE_CACHE = "program_by_code";
      /** Constant <code>ALL_PROGRAMS_CACHE="allPrograms"</code> */
      String ALL_PROGRAMS_CACHE = "all_programs";
      /** Constant <code>PROGRAMS_BY_CAMPAIGN_ID_CACHE="programsByCampaignId"</code> */
      String PROGRAMS_BY_CAMPAIGN_ID_CACHE = "programs_by_campaign_id";
      /** Constant <code>PROGRAMS_BY_CODES_CACHE="programsByCodes"</code> */
      String PROGRAMS_BY_CODES_CACHE = "programs_by_codes";
  
      /**
       * <p>getWritablePrograms.</p>
       *
       * @return a {@link java.util.List} object.
       */
      @Cacheable(value = ALL_PROGRAMS_CACHE)
      List<ProgramDTO> getAllPrograms();
  
      /**
       * <p>getWritableProgramByCode.</p>
       *
       * @param programCode a {@link java.lang.String} object.
       * @return a {@link fr.ifremer.dali.dto.configuration.programStrategy.ProgramDTO} object.
       */
      @Cacheable(value = PROGRAM_BY_CODE_CACHE)
      ProgramDTO getProgramByCode(String programCode);
  
      /**
       * <p>getProgramsByCampaignId.</p>
       *
       * Deprecated because the link between program and campaign is not mandatory
       *
       * @param campaignId a {@link java.lang.Integer} object.
       * @return a {@link java.util.List} object.
       */
      @Cacheable(value = PROGRAMS_BY_CAMPAIGN_ID_CACHE)
      @Deprecated
      List<ProgramDTO> getProgramsByCampaignId(Integer campaignId);
  
      /**
       * <p>getProgramsByCodes.</p>
       *
       * @param programCodes a {@link java.util.List} object.
       * @return a {@link java.util.List} object.
       */
      @Cacheable(value = PROGRAMS_BY_CODES_CACHE)
      List<ProgramDTO> getProgramsByCodes(List<String> programCodes);
  
      /**
       * <p>saveProgram.</p>
       *
       * @param program a {@link fr.ifremer.dali.dto.configuration.programStrategy.ProgramDTO} object.
       */
      @Caching(evict = {
              @CacheEvict(value = ALL_PROGRAMS_CACHE, allEntries = true),
              @CacheEvict(value = PROGRAMS_BY_CAMPAIGN_ID_CACHE, allEntries = true),
             @CacheEvict(value = PROGRAMS_BY_CODES_CACHE, allEntries = true),
             @CacheEvict(value = PROGRAM_BY_CODE_CACHE, key = "#program.code"),
             @CacheEvict(value = DaliStrategyDao.PMFM_STRATEGIES_BY_PROG_LOC_DATE_CACHE, allEntries = true),
             @CacheEvict(value = DaliMonitoringLocationDao.LOCATIONS_BY_CAMPAIGN_AND_PROGRAM_CACHE, allEntries = true)
     })
     void saveProgram(ProgramDTO program);
 
     /**
      * <p>remove.</p>
      *
      * @param programCode a {@link java.lang.String} object.
      */
     @Caching(evict = {
             @CacheEvict(value = ALL_PROGRAMS_CACHE, allEntries = true),
             @CacheEvict(value = PROGRAMS_BY_CAMPAIGN_ID_CACHE, allEntries = true),
             @CacheEvict(value = PROGRAMS_BY_CODES_CACHE, allEntries = true),
             @CacheEvict(value = PROGRAM_BY_CODE_CACHE, key = "#programCode"),
             @CacheEvict(value = DaliStrategyDao.PMFM_STRATEGIES_BY_PROG_LOC_DATE_CACHE, allEntries = true),
             @CacheEvict(value = DaliMonitoringLocationDao.LOCATIONS_BY_CAMPAIGN_AND_PROGRAM_CACHE, allEntries = true)
     })
     void remove(String programCode);
 
     /**
      * <p>deleteProgramLocations.</p>
      *
      * @param programCode a {@link java.lang.String} object.
      * @param monitoringLocationIds a {@link java.util.Collection} object.
      */
     @Caching(evict = {
             @CacheEvict(value = ALL_PROGRAMS_CACHE, allEntries = true),
             @CacheEvict(value = PROGRAMS_BY_CAMPAIGN_ID_CACHE, allEntries = true),
             @CacheEvict(value = PROGRAMS_BY_CODES_CACHE, allEntries = true),
             @CacheEvict(value = PROGRAM_BY_CODE_CACHE, key = "#programCode"),
             @CacheEvict(value = DaliStrategyDao.PMFM_STRATEGIES_BY_PROG_LOC_DATE_CACHE, allEntries = true),
             @CacheEvict(value = DaliMonitoringLocationDao.LOCATIONS_BY_CAMPAIGN_AND_PROGRAM_CACHE, allEntries = true)
     })
     void deleteProgramLocations(String programCode, Collection<Integer> monitoringLocationIds);
 
 
     /**
      * <p>findProgramsByCodeAndName.</p>
      *
      * @param statusCodes a {@link java.util.List} object.
      * @param code a {@link java.lang.String} object.
      * @param name a {@link java.lang.String} object.
      * @return a {@link java.util.List} object.
      */
     List<ProgramDTO> findProgramsByCodeAndName(List<String> statusCodes, String code, String name);
 
     /**
      * <p>findProgramsByLocationAndDate.</p>
      *
      * @param statusCodes a {@link java.util.List} object.
      * @param locationId a int.
      * @param date a {@link java.util.Date} object.
      * @return a {@link java.util.List} object.
      */
     List<ProgramDTO> findProgramsByLocationAndDate(List<String> statusCodes, int locationId, Date date);
 
     /**
      * <p>isProgramUsedByRuleList.</p>
      *
      * @param programCode a {@link java.lang.String} object.
      * @return a boolean.
      */
     boolean isProgramUsedByRuleList(String programCode);
 
 }