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.service;
017    
018    import java.util.List;
019    import java.util.Map;
020    
021    import org.kuali.kfs.module.bc.businessobject.BudgetConstructionOrganizationReports;
022    
023    /**
024     * This interface defines methods that an Budget Construction Organization Reports Service must provide.
025     */
026    public interface BudgetConstructionOrganizationReportsService {
027    
028        /**
029         * This method retrieves a Budget Construction Organization Reports instance by its composite primary keys (parameters passed
030         * in).
031         * 
032         * @param chartOfAccountsCode
033         * @param organizationCode
034         * @return a Budget Construction Organization Reports instance.
035         */
036        public BudgetConstructionOrganizationReports getByPrimaryId(String chartOfAccountsCode, String organizationCode);
037    
038        public List getBySearchCriteria(Class cls, Map searchCriteria);
039    
040        public List getBySearchCriteriaOrderByList(Class cls, Map searchCriteria, List<String> orderList);
041    
042        /**
043         * This method returns a list of child BC organization reports objects for the passed in org.
044         * 
045         * @param chartOfAccountsCode
046         * @param organizationCode
047         * @return
048         */
049        public List getActiveChildOrgs(String chartOfAccountsCode, String organizationCode);
050    
051        /**
052         * This method returns if an org is a leaf
053         * 
054         * @param chartOfAccountsCode
055         * @param organizationCode
056         * @return
057         */
058        public boolean isLeafOrg(String chartOfAccountsCode, String organizationCode);
059    }