001/*
002 * Copyright 2005-2006 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 */
016package org.kuali.ole.coa.service;
017
018import org.kuali.ole.coa.businessobject.SubAccount;
019
020/**
021 * This interface defines methods that a SubAccount Service must provide.
022 */
023public interface SubAccountService {
024    /**
025     * Retrieves a SubAccount object based on primary key.
026     * 
027     * @param chartOfAccountsCode - Chart of Accounts Code
028     * @param accountNumber - Account Number
029     * @param subAccountNumber - Sub Account Number
030     * @return SubAccount
031     * @see SubAccountService
032     */
033    public SubAccount getByPrimaryId(String chartOfAccountsCode, String accountNumber, String subAccountNumber);
034
035    /**
036     * Method is used by KualiSubAccountAttribute to enable caching for routing.
037     * 
038     * @see SubAccountService#getByPrimaryId(String, String, String)
039     */
040    public SubAccount getByPrimaryIdWithCaching(String chartOfAccountsCode, String accountNumber, String subAccountNumber);
041
042}