/**
    * Copyright 2004-2013 The Kuali Foundation
    *
    * Licensed under the Educational Community License, Version 2.0 (the "License");
    * you may not use this file except in compliance with the License.
    * You may obtain a copy of the License at
    *
    * http://www.opensource.org/licenses/ecl2.php
    *
   * Unless required by applicable law or agreed to in writing, software
   * distributed under the License is distributed on an "AS IS" BASIS,
   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   * See the License for the specific language governing permissions and
   * limitations under the License.
   */
  package org.kuali.hr.time.approval.service;
  
  import java.math.BigDecimal;
  import java.util.Date;
  import java.util.List;
  import java.util.Map;
  import java.util.Set;
  import java.util.SortedSet;
  
  import org.joda.time.DateTimeZone;
  import org.joda.time.Interval;
  import org.kuali.hr.core.KPMEConstants;
  import org.kuali.hr.lm.leaveblock.LeaveBlock;
  import org.kuali.hr.time.approval.web.ApprovalTimeSummaryRow;
  import org.kuali.hr.time.calendar.Calendar;
  import org.kuali.hr.time.calendar.CalendarEntries;
  import org.kuali.hr.time.timeblock.TimeBlock;
  import org.kuali.hr.time.workflow.TimesheetDocumentHeader;
  import org.kuali.rice.kew.api.note.Note;
  import org.kuali.rice.kew.routeheader.DocumentRouteHeaderValue;
  import org.springframework.cache.annotation.Cacheable;
  
  import com.google.common.collect.Multimap;
  
  
  public interface TimeApproveService {
  
      /**
       * Obtains a Map of Lists of ApprovalTimeSummaryRows. The Key to the map is
       * the PayCalendar Group name.
       *
       * @param payBeginDate
       * @param payEndDate
       * @param calGroup Specify a calendar group to filter by.
       * @return A Map<String, List<ApprovalTimeSummaryRow>> container.
       */
  	public List<ApprovalTimeSummaryRow> getApprovalSummaryRows(Date payBeginDate, Date payEndDate, String calGroup, List<String> principalIds, List<String> payCalendarLabels, CalendarEntries payCalendarEntries);
  	
  
  
  //	public List<ApprovalTimeSummaryRow> getApprovalSummaryRows(Date payBeginDate, Date payEndDate, String calGroup, List<String> principalIds);
  
      @Cacheable(value= KPMEConstants.KPME_GLOBAL_CACHE_NAME, key="'{PayCalendarLabelsForApprovalTab}' + 'payBeginDate=' + #p0 + '|' + 'payEndDate=' + #p1")
  	public List<String> getPayCalendarLabelsForApprovalTab(Date payBeginDate, Date payEndDate);
  
      /**
       * Method to obtain all of the active Pay Calendar Group names for the current
       * user / approver.
       * We used SortedSet here since we only want unique values while keeping the order.
       * Besides, we also need to get the first value as the default pay calendar group in some cases.
       * There is not get() method in the Set interface.
       *
       * @param payBeginDate
       * @param payEndDate
       * @return
       */
      public SortedSet<String> getApproverPayCalendarGroups(Date payBeginDate, Date payEndDate);
  
      /**
       * Used to determine if there are notes on a document
       * @param documentNumber
       * @return list of note objects
       */
  	public List<Note> getNotesForDocument(String documentNumber);
  
      public Map<String, BigDecimal> getHoursToPayDayMap(String principalId, Date payEndDate, List<String> payCalendarLabels, List<TimeBlock> lstTimeBlocks, List<LeaveBlock> leaveBlocks, Long workArea, CalendarEntries payCalendarEntries, Calendar payCalendar, DateTimeZone dateTimeZone, List<Interval> dayIntervals);
  
  	public Map<String, BigDecimal> getHoursToFlsaWeekMap(String principalId, Date payEndDate, List<String> payCalendarLabels, List<TimeBlock> lstTimeBlocks, List<LeaveBlock> leaveBlocks, Long workArea, CalendarEntries payCalendarEntries, Calendar payCalendar, DateTimeZone dateTimeZone, List<Interval> dayIntervals);
      /**
       * Method to provide a mapping of PayCalendarGroupNames to PayCalendarEntries to
       * allow for various starting points in Approval Tab Navigation.
       *
       * @param currentDate The current date. This method will search for active
       * assignments for this approver active as of this date, and 31 days prior
       * to pull back PayCalendarEntries.
       *
       * @return A CalendarGroup Name to PayCalendarEntries mapping.
       */
      public Map<String,CalendarEntries> getPayCalendarEntriesForApprover(String principalId, Date currentDate, String dept);
      
      /*
       * returns all Calendar entries with TimeSheetDocument created and can be approved by given principalId
       */
      public List<CalendarEntries> getAllPayCalendarEntriesForApprover(String principalId, Date currentDate);
     
 
     
     public boolean doesApproverHavePrincipalsForCalendarGroup(Date asOfDate, String calGroup);
     public Map<String,CalendarEntries> getPayCalendarEntriesForDept(String dept, Date currentDate);
 
     /**
      * Method to create a map that contains the principal's id and corresponding timesheet document header.
      *
      * @param payBeginDate
      * @param payEndDate
      * @return A PrincipalId to TimesheetDocumentHeader mapping.
      */
     Map<String, TimesheetDocumentHeader> getPrincipalDocumentHeader(List<String> principalIds, Date payBeginDate, Date payEndDate);
 
     /**
      * Method to create a map of the depts and their associated work areas based on the given approver work areas.
      *
      * @param approverWorkAres
      * @return A Dept and Work Areas mapping.
      */
     Multimap<String, Long> getDeptWorkAreasByWorkAreas(Set<Long> approverWorkAres);
 
     /**
      * Method to create a map of the depts and their associated work areas based on the given depts.
      *
      * @param userDepts
      * @return A Dept and Work Areas mapping.
      */
     Multimap<String, Long> getDeptWorkAreasByDepts(Set<String> userDepts);
     
     public DocumentRouteHeaderValue getRouteHeader(String documentId);
     
     /**
      * Get a list of unique principal ids with given criteria
      * used to populate tables in Time approval page 
      * @param workAreaList
      * @param calendarGroup
      * @param effdt
      * @param beginDate
      * @param endDate
      * @return
      */
     public List<String> getTimePrincipalIdsWithSearchCriteria(List<String> workAreaList, String calendarGroup, java.sql.Date effdt, java.sql.Date beginDate, java.sql.Date endDate);
 }