001    /*
002     * Copyright 2011 The Kuali Foundation.
003     * 
004     * Licensed under the Educational Community License, Version 2.0 (the "License");
005     * you may not use this file except in compliance with the License.
006     * You may obtain a copy of the License at
007     * 
008     * http://www.opensource.org/licenses/ecl2.php
009     * 
010     * Unless required by applicable law or agreed to in writing, software
011     * distributed under the License is distributed on an "AS IS" BASIS,
012     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013     * See the License for the specific language governing permissions and
014     * limitations under the License.
015     */
016    package org.kuali.kfs.sys.document;
017    
018    import org.kuali.kfs.coa.businessobject.AccountingPeriod;
019    
020    /**
021     * This defines methods common for all ledger posting.
022     */
023    public interface LedgerPostingDocument extends FinancialSystemTransactionalDocument {
024        /**
025         * @return posting year for this document
026         */
027        public Integer getPostingYear();
028    
029        /**
030         * Sets the posting year for this document
031         * 
032         * @param postingYear
033         */
034        public void setPostingYear(Integer postingYear);
035    
036        /**
037         * Gets the postingPeriodCode attribute. Part of <code>AccountingPeriod</code> Primary Key.
038         * 
039         * @return Returns the postingPeriodCode.
040         */
041        public String getPostingPeriodCode();
042    
043        /**
044         * Sets the postingPeriodCode attribute value. Part of <code>AccountingPeriod</code> Primary Key.
045         * 
046         * @param postingPeriodCode The postingPeriodCode to set.
047         */
048        public void setPostingPeriodCode(String postingPeriodCode);
049    
050    
051        /**
052         * This method retrieves the accounting period associated with this document.
053         */
054        public AccountingPeriod getAccountingPeriod();
055    
056        /**
057         * This method sets the accounting period associated with this document.
058         * 
059         * @param accountingPeriod
060         */
061        public void setAccountingPeriod(AccountingPeriod accountingPeriod);
062    }