View Javadoc
1   /*
2    * Copyright 2007 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.sys.document;
17  
18  import org.kuali.ole.coa.businessobject.AccountingPeriod;
19  
20  /**
21   * This defines methods common for all ledger posting.
22   */
23  public interface LedgerPostingDocument extends FinancialSystemTransactionalDocument {
24      /**
25       * @return posting year for this document
26       */
27      public Integer getPostingYear();
28  
29      /**
30       * Sets the posting year for this document
31       * 
32       * @param postingYear
33       */
34      public void setPostingYear(Integer postingYear);
35  
36      /**
37       * Gets the postingPeriodCode attribute. Part of <code>AccountingPeriod</code> Primary Key.
38       * 
39       * @return Returns the postingPeriodCode.
40       */
41      public String getPostingPeriodCode();
42  
43      /**
44       * Sets the postingPeriodCode attribute value. Part of <code>AccountingPeriod</code> Primary Key.
45       * 
46       * @param postingPeriodCode The postingPeriodCode to set.
47       */
48      public void setPostingPeriodCode(String postingPeriodCode);
49  
50  
51      /**
52       * This method retrieves the accounting period associated with this document.
53       */
54      public AccountingPeriod getAccountingPeriod();
55  
56      /**
57       * This method sets the accounting period associated with this document.
58       * 
59       * @param accountingPeriod
60       */
61      public void setAccountingPeriod(AccountingPeriod accountingPeriod);
62  }