01: /*
02: * Copyright 2005-2007 The Kuali Foundation.
03: *
04: * Licensed under the Educational Community License, Version 1.0 (the "License");
05: * you may not use this file except in compliance with the License.
06: * You may obtain a copy of the License at
07: *
08: * http://www.opensource.org/licenses/ecl1.php
09: *
10: * Unless required by applicable law or agreed to in writing, software
11: * distributed under the License is distributed on an "AS IS" BASIS,
12: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13: * See the License for the specific language governing permissions and
14: * limitations under the License.
15: */
16: package org.kuali.module.chart.service;
17:
18: import java.util.List;
19:
20: import org.kuali.module.chart.bo.SubAccount;
21:
22: /**
23: * This interface defines methods that a SubAccount Service must provide.
24: */
25: public interface SubAccountService {
26: /**
27: * Retrieves a SubAccount object based on primary key.
28: *
29: * @param chartOfAccountsCode - Chart of Accounts Code
30: * @param accountNumber - Account Number
31: * @param subAccountNumber - Sub Account Number
32: * @return SubAccount
33: * @see SubAccountService
34: */
35: public SubAccount getByPrimaryId(String chartOfAccountsCode,
36: String accountNumber, String subAccountNumber);
37:
38: /**
39: * Method is used by KualiSubAccountAttribute to enable caching for routing.
40: *
41: * @see SubAccountService#getByPrimaryId(String, String, String)
42: */
43: public SubAccount getByPrimaryIdWithCaching(
44: String chartOfAccountsCode, String accountNumber,
45: String subAccountNumber);
46:
47: /**
48: * Retrieves SubAccount objects associated with the given chart-org-subAccount code combination
49: *
50: * @param chartOfAccountsCode - 'Reports To' Chart of Accounts Code
51: * @param organizationCode - 'Reports To' Organization Code
52: * @param subAccountNumber - Sub Account Number
53: * @return a list of SubAccount objects
54: */
55: public List getSubAccountsByReportsToOrganization(
56: String chartOfAccountsCode, String organizationCode,
57: String subAccountNumber);
58: }
|