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.service;
017    
018    import org.kuali.kfs.coa.businessobject.SubObjectCode;
019    
020    /**
021     * This interface defines methods that a SubObjectCode Service must provide.
022     */
023    public interface SubObjectCodeService {
024        /**
025         * Specifies what a method that searches based on the Primary Key of an SubObjectCode object must look like.
026         * 
027         * @param universityFiscalYear
028         * @param chartOfAccountsCode
029         * @param accountNumber
030         * @param financialObjectCode
031         * @param financialSubObjectCode
032         * @return SubObjectCode
033         */
034        public SubObjectCode getByPrimaryId(Integer universityFiscalYear, String chartOfAccountsCode, String accountNumber, String financialObjectCode, String financialSubObjectCode);
035    
036        /**
037         * This method returns an financial object code for the current fiscal year.
038         * 
039         * @param chartOfAccountsCode chart of accounts code for object code
040         * @param financialObjectCode financial object code
041         * @return the object code specified
042         */
043        public SubObjectCode getByPrimaryIdForCurrentYear(String chartOfAccountsCode, String accountNumber, String financialObjectCode, String financialSubObjectCode);
044    }