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.sql.Date;
020    import java.util.LinkedHashMap;
021    
022    import org.kuali.kfs.sys.KFSPropertyConstants;
023    import org.kuali.kfs.sys.businessobject.Bank;
024    import org.kuali.rice.kns.bo.PersistableBusinessObjectBase;
025    import org.kuali.rice.kns.util.KualiDecimal;
026    
027    /**
028     * This class is used to represent a revolving fund detail business object.
029     */
030    public class RevolvingFundDetail extends PersistableBusinessObjectBase {
031    
032        private String documentNumber;
033        private String financialDocumentTypeCode;
034        private String financialDocumentColumnTypeCode;
035        private Integer financialDocumentLineNumber;
036        private Date financialDocumentRevolvingFundDate;
037        private String financialDocumentRevolvingFundReferenceNumber;
038        private String financialDocumentRevolvingFundDescription;
039        private KualiDecimal financialDocumentRevolvingFundAmount;
040        private String financialDocumentBankCode;
041        
042        private Bank bank;
043    
044        /**
045         * Default constructor.
046         */
047        public RevolvingFundDetail() {
048            bank = new Bank();
049        }
050    
051        /**
052         * Gets the documentNumber attribute.
053         * 
054         * @return Returns the documentNumber
055         */
056        public String getDocumentNumber() {
057            return documentNumber;
058        }
059    
060        /**
061         * Sets the documentNumber attribute.
062         * 
063         * @param documentNumber The documentNumber to set.
064         */
065        public void setDocumentNumber(String documentNumber) {
066            this.documentNumber = documentNumber;
067        }
068    
069    
070        /**
071         * Gets the financialDocumentTypeCode attribute.
072         * 
073         * @return Returns the financialDocumentTypeCode
074         */
075        public String getFinancialDocumentTypeCode() {
076            return financialDocumentTypeCode;
077        }
078    
079        /**
080         * Sets the financialDocumentTypeCode attribute.
081         * 
082         * @param financialDocumentTypeCode The financialDocumentTypeCode to set.
083         */
084        public void setFinancialDocumentTypeCode(String financialDocumentTypeCode) {
085            this.financialDocumentTypeCode = financialDocumentTypeCode;
086        }
087    
088    
089        /**
090         * Gets the financialDocumentColumnTypeCode attribute.
091         * 
092         * @return Returns the financialDocumentColumnTypeCode
093         */
094        public String getFinancialDocumentColumnTypeCode() {
095            return financialDocumentColumnTypeCode;
096        }
097    
098        /**
099         * Sets the financialDocumentColumnTypeCode attribute.
100         * 
101         * @param financialDocumentColumnTypeCode The financialDocumentColumnTypeCode to set.
102         */
103        public void setFinancialDocumentColumnTypeCode(String financialDocumentColumnTypeCode) {
104            this.financialDocumentColumnTypeCode = financialDocumentColumnTypeCode;
105        }
106    
107    
108        /**
109         * Gets the financialDocumentLineNumber attribute.
110         * 
111         * @return Returns the financialDocumentLineNumber
112         */
113        public Integer getFinancialDocumentLineNumber() {
114            return financialDocumentLineNumber;
115        }
116    
117        /**
118         * Sets the financialDocumentLineNumber attribute.
119         * 
120         * @param financialDocumentLineNumber The financialDocumentLineNumber to set.
121         */
122        public void setFinancialDocumentLineNumber(Integer financialDocumentLineNumber) {
123            this.financialDocumentLineNumber = financialDocumentLineNumber;
124        }
125    
126    
127        /**
128         * Gets the financialDocumentRevolvingFundDate attribute.
129         * 
130         * @return Returns the financialDocumentRevolvingFundDate
131         */
132        public Date getFinancialDocumentRevolvingFundDate() {
133            return financialDocumentRevolvingFundDate;
134        }
135    
136        /**
137         * Sets the financialDocumentRevolvingFundDate attribute.
138         * 
139         * @param financialDocumentRevolvingFundDate The financialDocumentRevolvingFundDate to set.
140         */
141        public void setFinancialDocumentRevolvingFundDate(Date financialDocumentRevolvingFundDate) {
142            this.financialDocumentRevolvingFundDate = financialDocumentRevolvingFundDate;
143        }
144    
145    
146        /**
147         * Gets the financialDocumentRevolvingFundReferenceNumber attribute.
148         * 
149         * @return Returns the financialDocumentRevolvingFundReferenceNumber
150         */
151        public String getFinancialDocumentRevolvingFundReferenceNumber() {
152            return financialDocumentRevolvingFundReferenceNumber;
153        }
154    
155        /**
156         * Sets the financialDocumentRevolvingFundReferenceNumber attribute.
157         * 
158         * @param financialDocumentRevolvingFundReferenceNumber The financialDocumentRevolvingFundReferenceNumber to set.
159         */
160        public void setFinancialDocumentRevolvingFundReferenceNumber(String financialDocumentRevolvingFundReferenceNumber) {
161            this.financialDocumentRevolvingFundReferenceNumber = financialDocumentRevolvingFundReferenceNumber;
162        }
163    
164    
165        /**
166         * Gets the financialDocumentRevolvingFundDescription attribute.
167         * 
168         * @return Returns the financialDocumentRevolvingFundDescription
169         */
170        public String getFinancialDocumentRevolvingFundDescription() {
171            return financialDocumentRevolvingFundDescription;
172        }
173    
174        /**
175         * Sets the financialDocumentRevolvingFundDescription attribute.
176         * 
177         * @param financialDocumentRevolvingFundDescription The financialDocumentRevolvingFundDescription to set.
178         */
179        public void setFinancialDocumentRevolvingFundDescription(String financialDocumentRevolvingFundDescription) {
180            this.financialDocumentRevolvingFundDescription = financialDocumentRevolvingFundDescription;
181        }
182    
183    
184        /**
185         * Gets the financialDocumentRevolvingFundAmount attribute.
186         * 
187         * @return Returns the financialDocumentRevolvingFundAmount
188         */
189        public KualiDecimal getFinancialDocumentRevolvingFundAmount() {
190            return financialDocumentRevolvingFundAmount;
191        }
192    
193        /**
194         * Sets the financialDocumentRevolvingFundAmount attribute.
195         * 
196         * @param financialDocumentRevolvingFundAmount The financialDocumentRevolvingFundAmount to set.
197         */
198        public void setFinancialDocumentRevolvingFundAmount(KualiDecimal financialDocumentRevolvingFundAmount) {
199            this.financialDocumentRevolvingFundAmount = financialDocumentRevolvingFundAmount;
200        }
201    
202    
203        /**
204         * Gets the financialDocumentBankCode attribute.
205         * 
206         * @return Returns the financialDocumentBankCode
207         */
208        public String getFinancialDocumentBankCode() {
209            return financialDocumentBankCode;
210        }
211    
212        /**
213         * Sets the financialDocumentBankCode attribute.
214         * 
215         * @param financialDocumentBankCode The financialDocumentBankCode to set.
216         */
217        public void setFinancialDocumentBankCode(String financialDocumentBankCode) {
218            this.financialDocumentBankCode = financialDocumentBankCode;
219        }
220    
221        /**
222         * Gets the bank attribute.
223         * 
224         * @return Returns the bank.
225         */
226        public Bank getBank() {
227            return bank;
228        }
229    
230        /**
231         * Sets the bank attribute value.
232         * 
233         * @param bank The bank to set.
234         */
235        public void setBank(Bank bank) {
236            this.bank = bank;
237        }
238    
239        /**
240         * @see org.kuali.rice.kns.bo.BusinessObjectBase#toStringMapper()
241         */
242        protected LinkedHashMap toStringMapper() {
243            LinkedHashMap m = new LinkedHashMap();
244            m.put(KFSPropertyConstants.DOCUMENT_NUMBER, this.documentNumber);
245            m.put("financialDocumentTypeCode", this.financialDocumentTypeCode);
246            m.put("financialDocumentColumnTypeCode", this.financialDocumentColumnTypeCode);
247            if (this.financialDocumentLineNumber != null) {
248                m.put("financialDocumentLineNumber", this.financialDocumentLineNumber.toString());
249            }
250            return m;
251        }
252    }