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.coa.dataaccess;
017    
018    import java.util.List;
019    
020    import org.kuali.kfs.coa.businessobject.SubAccount;
021    
022    
023    /**
024     * This interface defines basic methods that SubAccount Dao's must provide
025     */
026    public interface SubAccountDao {
027    
028        /**
029         * Retrieves a {@link SubAccount} object by primary key.
030         * 
031         * @param chartOfAccountsCode - part of composite key
032         * @param accountNumber - part of composite key
033         * @param subAccountNumber - part of composite key
034         * @return {@link SubAccount} by primary key
035         */
036        public SubAccount getByPrimaryId(String chartOfAccountsCode, String accountNumber, String subAccountNumber);
037    
038        /**
039         * Retrieves {@link SubAccount} objects associated with the given chart-org-subAccount code combination
040         * 
041         * @param chartOfAccountsCode - 'Reports To' Chart of Accounts Code
042         * @param organizationCode - 'Reports To' Organization Code
043         * @param subAccountNumber - Sub Account Number
044         * @return a list of {@link SubAccount} objects
045         */
046        public List getSubAccountsByReportsToOrganization(String chartOfAccountsCode, String organizationCode, String subAccountNumber);
047    }