1 /*
2 * Copyright 2006 The Kuali Foundation
3 *
4 * Licensed under the Educational Community License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.opensource.org/licenses/ecl2.php
9 *
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.ole.coa.service;
17
18 import org.kuali.ole.coa.businessobject.A21SubAccount;
19
20 /**
21 *
22 * This interface defines the methods for retrieving fully populated A21SubAccount objects
23 */
24 public interface A21SubAccountService {
25
26 /**
27 *
28 * This retrieves an A21SubAccount by its primary keys of chart of accounts code, account number and
29 * sub account number
30 * @param chartOfAccountsCode
31 * @param accountNumber
32 * @param subAccountNumber
33 * @return the A21SubAccount that matches this primary key
34 */
35 public A21SubAccount getByPrimaryKey(String chartOfAccountsCode, String accountNumber, String subAccountNumber);
36
37 /**
38 * build a CG ICR account
39 * @param chartOfAccountsCode the given chart of account
40 * @param accountNumber the given account number
41 * @param subAccountNumber the given sub account number
42 * @param subAccountTypeCode the type of the CG ICR account
43 * @return a CG ICR account built from the given information
44 */
45 public A21SubAccount buildCgIcrAccount(String chartOfAccountsCode, String accountNumber, String subAccountNumber, String subAccountTypeCode);
46
47 /**
48 * populate the a21 sub account with the given account
49 *
50 * @param a21SubAccount the a21 sub account needed to be populated
51 * @param chartOfAccountsCode the given chart of account
52 * @param accountNumber the given account number
53 */
54 public void populateCgIcrAccount(A21SubAccount a21SubAccount, String chartOfAccountsCode, String accountNumber);
55 }