1 /*
2 * The Kuali Financial System, a comprehensive financial management system for higher education.
3 *
4 * Copyright 2005-2014 The Kuali Foundation
5 *
6 * This program is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU Affero General Public License as
8 * published by the Free Software Foundation, either version 3 of the
9 * License, or (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU Affero General Public License for more details.
15 *
16 * You should have received a copy of the GNU Affero General Public License
17 * along with this program. If not, see <http://www.gnu.org/licenses/>.
18 */
19 package org.kuali.kfs.sys.document;
20
21 import org.kuali.kfs.coa.businessobject.AccountingPeriod;
22
23 /**
24 * This defines methods common for all ledger posting.
25 */
26 public interface LedgerPostingDocument extends FinancialSystemTransactionalDocument {
27 /**
28 * @return posting year for this document
29 */
30 public Integer getPostingYear();
31
32 /**
33 * Sets the posting year for this document
34 *
35 * @param postingYear
36 */
37 public void setPostingYear(Integer postingYear);
38
39 /**
40 * Gets the postingPeriodCode attribute. Part of <code>AccountingPeriod</code> Primary Key.
41 *
42 * @return Returns the postingPeriodCode.
43 */
44 public String getPostingPeriodCode();
45
46 /**
47 * Sets the postingPeriodCode attribute value. Part of <code>AccountingPeriod</code> Primary Key.
48 *
49 * @param postingPeriodCode The postingPeriodCode to set.
50 */
51 public void setPostingPeriodCode(String postingPeriodCode);
52
53
54 /**
55 * This method retrieves the accounting period associated with this document.
56 */
57 public AccountingPeriod getAccountingPeriod();
58
59 /**
60 * This method sets the accounting period associated with this document.
61 *
62 * @param accountingPeriod
63 */
64 public void setAccountingPeriod(AccountingPeriod accountingPeriod);
65 }