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.Collection;
019    import java.util.List;
020    
021    import org.kuali.kfs.coa.businessobject.Chart;
022    import org.kuali.rice.kim.bo.Person;
023    
024    /**
025     * This interface defines what methods of data retrieval should be allowed for {@link org.kuali.kfs.coa.businessobject.Chart}
026     */
027    public interface ChartDao {
028        /**
029         * This method retrieves all Chart objects in the system
030         * 
031         * @return all Chart objects
032         */
033        public Collection getAll();
034    
035        /**
036         * This method retrieves the University's Chart object
037         * 
038         * @return University's chart object
039         */
040        public Chart getUniversityChart();
041    
042        /**
043         * This method retrieves a given Chart based on it's primary key
044         * 
045         * @param chartOfAccountsCode
046         * @return Chart object that matches this primary key
047         */
048        public Chart getByPrimaryId(String chartOfAccountsCode);
049    
050        /**
051         * This method retrieves a list of Chart objects that a specific User is responsible for
052         * 
053         * @param kualiUser
054         * @return list of Chart objects that this user is responsible for
055         */
056        public List getChartsThatUserIsResponsibleFor(Person kualiUser);
057    }
058