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    
017    package org.kuali.kfs.fp.businessobject;
018    
019    import java.util.LinkedHashMap;
020    
021    import org.kuali.kfs.sys.KFSPropertyConstants;
022    import org.kuali.rice.kns.bo.DocumentHeader;
023    import org.kuali.rice.kns.bo.PersistableBusinessObjectBase;
024    
025    /**
026     * This class is used to represent a distribution document.
027     */
028    public class DistributionDoc extends PersistableBusinessObjectBase {
029    
030        private String documentNumber;
031        private Integer finDocumentNextFromLineNbr;
032        private Integer finDocumentNextToLineNumber;
033        private Integer financialDocumentPostingYear;
034        private String finDocumentPostingPeriodCode;
035    
036        private DocumentHeader financialDocument;
037    
038        /**
039         * Default no-arg constructor.
040         */
041        public DistributionDoc() {
042    
043        }
044    
045        /**
046         * Gets the documentNumber attribute.
047         * 
048         * @return Returns the documentNumber
049         */
050        public String getDocumentNumber() {
051            return documentNumber;
052        }
053    
054    
055        /**
056         * Sets the documentNumber attribute.
057         * 
058         * @param documentNumber The documentNumber to set.
059         */
060        public void setDocumentNumber(String documentNumber) {
061            this.documentNumber = documentNumber;
062        }
063    
064        /**
065         * Gets the finDocumentNextFromLineNbr attribute.
066         * 
067         * @return Returns the finDocumentNextFromLineNbr
068         */
069        public Integer getFinDocumentNextFromLineNbr() {
070            return finDocumentNextFromLineNbr;
071        }
072    
073    
074        /**
075         * Sets the finDocumentNextFromLineNbr attribute.
076         * 
077         * @param finDocumentNextFromLineNbr The finDocumentNextFromLineNbr to set.
078         */
079        public void setFinDocumentNextFromLineNbr(Integer finDocumentNextFromLineNbr) {
080            this.finDocumentNextFromLineNbr = finDocumentNextFromLineNbr;
081        }
082    
083        /**
084         * Gets the finDocumentNextToLineNumber attribute.
085         * 
086         * @return Returns the finDocumentNextToLineNumber
087         */
088        public Integer getFinDocumentNextToLineNumber() {
089            return finDocumentNextToLineNumber;
090        }
091    
092    
093        /**
094         * Sets the finDocumentNextToLineNumber attribute.
095         * 
096         * @param finDocumentNextToLineNumber The finDocumentNextToLineNumber to set.
097         */
098        public void setFinDocumentNextToLineNumber(Integer finDocumentNextToLineNumber) {
099            this.finDocumentNextToLineNumber = finDocumentNextToLineNumber;
100        }
101    
102        /**
103         * Gets the financialDocumentPostingYear attribute.
104         * 
105         * @return Returns the financialDocumentPostingYear
106         */
107        public Integer getFinancialDocumentPostingYear() {
108            return financialDocumentPostingYear;
109        }
110    
111    
112        /**
113         * Sets the financialDocumentPostingYear attribute.
114         * 
115         * @param financialDocumentPostingYear The financialDocumentPostingYear to set.
116         */
117        public void setFinancialDocumentPostingYear(Integer financialDocumentPostingYear) {
118            this.financialDocumentPostingYear = financialDocumentPostingYear;
119        }
120    
121        /**
122         * Gets the finDocumentPostingPeriodCode attribute.
123         * 
124         * @return Returns the finDocumentPostingPeriodCode
125         */
126        public String getFinDocumentPostingPeriodCode() {
127            return finDocumentPostingPeriodCode;
128        }
129    
130    
131        /**
132         * Sets the finDocumentPostingPeriodCode attribute.
133         * 
134         * @param finDocumentPostingPeriodCode The finDocumentPostingPeriodCode to set.
135         */
136        public void setFinDocumentPostingPeriodCode(String finDocumentPostingPeriodCode) {
137            this.finDocumentPostingPeriodCode = finDocumentPostingPeriodCode;
138        }
139    
140        /**
141         * Gets the financialDocument attribute.
142         * 
143         * @return Returns the financialDocument
144         */
145        public DocumentHeader getFinancialDocument() {
146            return financialDocument;
147        }
148    
149    
150        /**
151         * Sets the financialDocument attribute.
152         * 
153         * @param financialDocument The financialDocument to set.
154         * @deprecated
155         */
156        public void setFinancialDocument(DocumentHeader financialDocument) {
157            this.financialDocument = financialDocument;
158        }
159    
160        /**
161         * @see org.kuali.rice.kns.bo.BusinessObjectBase#toStringMapper()
162         */
163        protected LinkedHashMap toStringMapper() {
164            LinkedHashMap m = new LinkedHashMap();
165            m.put(KFSPropertyConstants.DOCUMENT_NUMBER, this.documentNumber);
166            return m;
167        }
168    }