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 java.util.List; 019 020 import org.kuali.kfs.coa.businessobject.SubAccount; 021 022 /** 023 * This interface defines methods that a SubAccount Service must provide. 024 */ 025 public interface SubAccountService { 026 /** 027 * Retrieves a SubAccount object based on primary key. 028 * 029 * @param chartOfAccountsCode - Chart of Accounts Code 030 * @param accountNumber - Account Number 031 * @param subAccountNumber - Sub Account Number 032 * @return SubAccount 033 * @see SubAccountService 034 */ 035 public SubAccount getByPrimaryId(String chartOfAccountsCode, String accountNumber, String subAccountNumber); 036 037 /** 038 * Method is used by KualiSubAccountAttribute to enable caching for routing. 039 * 040 * @see SubAccountService#getByPrimaryId(String, String, String) 041 */ 042 public SubAccount getByPrimaryIdWithCaching(String chartOfAccountsCode, String accountNumber, String subAccountNumber); 043 044 /** 045 * Retrieves SubAccount objects associated with the given chart-org-subAccount code combination 046 * 047 * @param chartOfAccountsCode - 'Reports To' Chart of Accounts Code 048 * @param organizationCode - 'Reports To' Organization Code 049 * @param subAccountNumber - Sub Account Number 050 * @return a list of SubAccount objects 051 */ 052 public List getSubAccountsByReportsToOrganization(String chartOfAccountsCode, String organizationCode, String subAccountNumber); 053 }