001    /*
002     * Copyright 2011 The Kuali Foundation.
003     * 
004     * Licensed under the Educational Community License, Version 2.0 (the "License");
005     * you may not use this file except in compliance with the License.
006     * You may obtain a copy of the License at
007     * 
008     * http://www.opensource.org/licenses/ecl2.php
009     * 
010     * Unless required by applicable law or agreed to in writing, software
011     * distributed under the License is distributed on an "AS IS" BASIS,
012     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013     * See the License for the specific language governing permissions and
014     * limitations under the License.
015     */
016    package org.kuali.kfs.module.ec.dataaccess;
017    
018    import java.util.List;
019    
020    import org.kuali.kfs.integration.ec.EffortCertificationReport;
021    import org.kuali.kfs.module.ec.businessobject.EffortCertificationReportDefinition;
022    
023    /**
024     * Provides interface for data operations on the EffortCertificationReportDefinition table
025     */
026    public interface EffortCertificationReportDefinitionDao {
027    
028        /**
029         * Finds all effort certification report definitions that have the same report type code and are active (excluding the current record)
030         * 
031         * @param effortCertificationReportDefinition
032         * @return
033         */
034        public List<EffortCertificationReportDefinition> getAllOtherActiveByType(EffortCertificationReportDefinition effortCertificationReportDefinition);
035    
036        /**
037         * Retrieves all EffortCertificationReportDefinition records
038         * 
039         * @return list of EffortCertificationReportDefinition records
040         */
041        public List<EffortCertificationReportDefinition> getAll();
042        
043        /**
044         * Retrieves all EffortCertificationReportDefinition records that have a begin or end period fiscal year equal to the given
045         * fiscal year, and report on pay given by the position object group code.
046         * 
047         * @param fiscalYear - fiscal year for being or end period
048         * @param positionObjectCode - position object group code for report definition
049         * @return effort report definitions with a period in the given year and report for given position code
050         */
051        public List<EffortCertificationReport> getAllByYearAndPositionCode(Integer fiscalYear, String positionObjectCode);
052    }