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    /**
019     * This class...
020     */
021    public interface OrganizationBCDocumentSearchDao {
022    
023        /**
024         * This method populates BudgetConstructionAccountSelect with rows associated with a set of selected organizations in the
025         * Organization Tree for the user and where Budget Documents exist.
026         * 
027         * @param principalName
028         * @param universityFiscalYear
029         */
030        public int buildAccountSelectPullList(String principalName, Integer universityFiscalYear);
031        
032        /**
033         * Populates BudgetConstructionAccountSelect with accounts that are above the user's current point of view
034         * and returns the number of rows inserted (which equates to number of accounts above).
035         * 
036         * @param principalName user who we are building the list for
037         * @param universityFiscalYear budget year for records to look at
038         * @param chartOfAccountsCode chart code of user's current point of view
039         * @param organizationCode organization code of user's current point of view
040         * @return int number of rows inserted
041         */
042        public int buildBudgetedAccountsAbovePointsOfView(String principalName, Integer universityFiscalYear, String chartOfAccountsCode, String organizationCode);
043        
044        /**
045         * Populates BudgetConstructionAccountSelect with accounts that the given user is a manager or delegate for. Returns the number of rows
046         * inserted.
047         * 
048         * @param principalName manager or delegate universal identifier
049         * @param universityFiscalYear budget fiscal year
050         */
051        public int buildAccountManagerDelegateList(String principalName, Integer universityFiscalYear);
052        
053        /**
054         * This method depopulates BudgetConstructionAccountSelect rows associated with the user.
055         * 
056         * @param principalName
057         */
058        public void cleanAccountSelectPullList(String principalName);
059    }
060