01: /*
02: * Copyright 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.gl.bo;
17:
18: import org.kuali.module.chart.bo.Account;
19:
20: /**
21: * An interface that declares the methods that a Business Object must implement, if it should have its flexible offset account updated by
22: * the FlexibleOffsetAccountService.
23: * @see org.kuali.module.financial.service.FlexibleOffsetAccountService
24: */
25: public interface FlexibleAccountUpdateable {
26: /**
27: * Returns the university fiscal year of the business object to update
28: * @return a valid university fiscal year
29: */
30: public abstract Integer getUniversityFiscalYear();
31:
32: /**
33: * Returns the chart of accounts code of the business object to update
34: * @return a valid chart of accounts code
35: */
36: public abstract String getChartOfAccountsCode();
37:
38: /**
39: * Returns the account number of the business object to update
40: * @return a valid account number
41: */
42: public abstract String getAccountNumber();
43:
44: /**
45: * Returns the balance type code of the business object to update
46: * @return a valid balance type code
47: */
48: public abstract String getFinancialBalanceTypeCode();
49:
50: /**
51: * Returns the document type code of the business object to update
52: * @return a valid document code
53: */
54: public abstract String getFinancialDocumentTypeCode();
55:
56: /**
57: * Returns the object code of the business object to update
58: * @return a valid object code
59: */
60: public abstract String getFinancialObjectCode();
61:
62: /**
63: * Sets the business object's account attribute
64: * @param a an account business object to set
65: */
66: public abstract void setAccount(Account a);
67:
68: /**
69: * Sets the chart of accounts code of the business object
70: * @param chartCode the chart code to set
71: */
72: public abstract void setChartOfAccountsCode(String chartCode);
73:
74: /**
75: * Sets the account number of the business object
76: * @param accountNumber the account number to set
77: */
78: public abstract void setAccountNumber(String accountNumber);
79:
80: /**
81: * Sets the sub-account number of the business object
82: * @param subAccountNumber the sub account number to set
83: */
84: public abstract void setSubAccountNumber(String subAccountNumber);
85:
86: /**
87: * Sets the financial sub-object code of the business object
88: * @param financialSubObjectCode the financial sub-object code to set
89: */
90: public abstract void setFinancialSubObjectCode(
91: String financialSubObjectCode);
92: }
|