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.bc.document.dataaccess;
017    
018    import java.util.Collection;
019    import java.util.List;
020    import java.util.Map;
021    
022    import org.kuali.kfs.module.bc.businessobject.BudgetConstructionOrganizationReports;
023    
024    public interface BudgetConstructionOrganizationReportsDao {
025        /**
026         * gets a BudgetConstructionOrganizationReports object with PrimaryId
027         * 
028         * @param chartOfAccountsCode
029         * @param organizationCode
030         * @return
031         */
032        public BudgetConstructionOrganizationReports getByPrimaryId(String chartOfAccountsCode, String organizationCode);
033        
034        /**
035         * gets Collection with searchCriteria
036         * 
037         * @param cls
038         * @param searchCriteria
039         * @return
040         */
041        public Collection getBySearchCriteria(Class cls, Map searchCriteria);
042        
043        /**
044         * gets Collection with searchCriteria and OrderByList
045         * 
046         * @param cls
047         * @param searchCriteria
048         * @param orderList
049         * @return
050         */
051        public Collection getBySearchCriteriaWithOrderByList(Class cls, Map searchCriteria, List<String> orderList);
052        
053        /**
054         * This method returns active organizations that report to the passed in organization.
055         * 
056         * @param chartOfAccountsCode
057         * @param organizationCode
058         * @return
059         */
060        public List getActiveChildOrgs(String chartOfAccountsCode, String organizationCode);
061    
062        /**
063         * This method returns whether or not an organization is a leaf in the reports to tree
064         * 
065         * @param chartOfAccountsCode
066         * @param organizationCode
067         * @return
068         */
069        public boolean isLeafOrg(String chartOfAccountsCode, String organizationCode);
070    
071    }