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.PersistableBusinessObjectBase;
023    
024    /**
025     * This class is used to represent a disbursement voucher wire transfer.
026     */
027    public class DisbursementVoucherWireTransfer extends PersistableBusinessObjectBase {
028    
029        private String documentNumber;
030        private String disbursementVoucherBankName;
031        private String disbVchrBankRoutingNumber;
032        private String disbVchrBankCityName;
033        private String disbVchrBankStateCode;
034        private String disbVchrBankCountryCode;
035        private String disbVchrAttentionLineText;
036        private String disbVchrAdditionalWireText;
037        private String disbVchrPayeeAccountNumber;
038        private String disbVchrCurrencyTypeName;
039        private String disbVchrCurrencyTypeCode;
040        private boolean disbursementVoucherWireTransferFeeWaiverIndicator;
041        private String disbursementVoucherPayeeAccountName;
042        private String disbursementVoucherPayeeAccountTypeCode;
043        private String disbursementVoucherAutomatedClearingHouseProfileNumber;
044        private String disbursementVoucherForeignCurrencyTypeName;
045        private String disbursementVoucherForeignCurrencyTypeCode;
046    
047    
048        /**
049         * Default no-arg constructor.
050         */
051        public DisbursementVoucherWireTransfer() {
052            disbursementVoucherWireTransferFeeWaiverIndicator = false;
053        }
054    
055        /**
056         * Gets the documentNumber attribute.
057         * 
058         * @return Returns the documentNumber
059         */
060        public String getDocumentNumber() {
061            return documentNumber;
062        }
063    
064    
065        /**
066         * Sets the documentNumber attribute.
067         * 
068         * @param documentNumber The documentNumber to set.
069         */
070        public void setDocumentNumber(String documentNumber) {
071            this.documentNumber = documentNumber;
072        }
073    
074        /**
075         * Gets the disbursementVoucherBankName attribute.
076         * 
077         * @return Returns the disbursementVoucherBankName
078         */
079        public String getDisbursementVoucherBankName() {
080            return disbursementVoucherBankName;
081        }
082    
083    
084        /**
085         * Sets the disbursementVoucherBankName attribute.
086         * 
087         * @param disbursementVoucherBankName The disbursementVoucherBankName to set.
088         */
089        public void setDisbursementVoucherBankName(String disbursementVoucherBankName) {
090            this.disbursementVoucherBankName = disbursementVoucherBankName;
091        }
092    
093        /**
094         * Gets the disbVchrBankRoutingNumber attribute.
095         * 
096         * @return Returns the disbVchrBankRoutingNumber
097         */
098        public String getDisbVchrBankRoutingNumber() {
099            return disbVchrBankRoutingNumber;
100        }
101    
102    
103        /**
104         * Sets the disbVchrBankRoutingNumber attribute.
105         * 
106         * @param disbVchrBankRoutingNumber The disbVchrBankRoutingNumber to set.
107         */
108        public void setDisbVchrBankRoutingNumber(String disbVchrBankRoutingNumber) {
109            this.disbVchrBankRoutingNumber = disbVchrBankRoutingNumber;
110        }
111    
112        /**
113         * Gets the disbVchrBankCityName attribute.
114         * 
115         * @return Returns the disbVchrBankCityName
116         */
117        public String getDisbVchrBankCityName() {
118            return disbVchrBankCityName;
119        }
120    
121    
122        /**
123         * Sets the disbVchrBankCityName attribute.
124         * 
125         * @param disbVchrBankCityName The disbVchrBankCityName to set.
126         */
127        public void setDisbVchrBankCityName(String disbVchrBankCityName) {
128            this.disbVchrBankCityName = disbVchrBankCityName;
129        }
130    
131        /**
132         * Gets the disbVchrBankStateCode attribute.
133         * 
134         * @return Returns the disbVchrBankStateCode
135         */
136        public String getDisbVchrBankStateCode() {
137            return disbVchrBankStateCode;
138        }
139    
140    
141        /**
142         * Sets the disbVchrBankStateCode attribute.
143         * 
144         * @param disbVchrBankStateCode The disbVchrBankStateCode to set.
145         */
146        public void setDisbVchrBankStateCode(String disbVchrBankStateCode) {
147            this.disbVchrBankStateCode = disbVchrBankStateCode;
148        }
149    
150        /**
151         * Gets the disbVchrBankCountryCode attribute.
152         * 
153         * @return Returns the disbVchrBankCountryCode
154         */
155        public String getDisbVchrBankCountryCode() {
156            return disbVchrBankCountryCode;
157        }
158    
159    
160        /**
161         * Sets the disbVchrBankCountryCode attribute.
162         * 
163         * @param disbVchrBankCountryCode The disbVchrBankCountryCode to set.
164         */
165        public void setDisbVchrBankCountryCode(String disbVchrBankCountryCode) {
166            this.disbVchrBankCountryCode = disbVchrBankCountryCode;
167        }
168    
169        /**
170         * Gets the disbVchrAttentionLineText attribute.
171         * 
172         * @return Returns the disbVchrAttentionLineText
173         */
174        public String getDisbVchrAttentionLineText() {
175            return disbVchrAttentionLineText;
176        }
177    
178    
179        /**
180         * Sets the disbVchrAttentionLineText attribute.
181         * 
182         * @param disbVchrAttentionLineText The disbVchrAttentionLineText to set.
183         */
184        public void setDisbVchrAttentionLineText(String disbVchrAttentionLineText) {
185            this.disbVchrAttentionLineText = disbVchrAttentionLineText;
186        }
187    
188        /**
189         * Gets the disbVchrAdditionalWireText attribute.
190         * 
191         * @return Returns the disbVchrAdditionalWireText
192         */
193        public String getDisbVchrAdditionalWireText() {
194            return disbVchrAdditionalWireText;
195        }
196    
197    
198        /**
199         * Sets the disbVchrAdditionalWireText attribute.
200         * 
201         * @param disbVchrAdditionalWireText The disbVchrAdditionalWireText to set.
202         */
203        public void setDisbVchrAdditionalWireText(String disbVchrAdditionalWireText) {
204            this.disbVchrAdditionalWireText = disbVchrAdditionalWireText;
205        }
206    
207        /**
208         * Gets the disbVchrPayeeAccountNumber attribute.
209         * 
210         * @return Returns the disbVchrPayeeAccountNumber
211         */
212        public String getDisbVchrPayeeAccountNumber() {
213            return disbVchrPayeeAccountNumber;
214        }
215    
216    
217        /**
218         * Sets the disbVchrPayeeAccountNumber attribute.
219         * 
220         * @param disbVchrPayeeAccountNumber The disbVchrPayeeAccountNumber to set.
221         */
222        public void setDisbVchrPayeeAccountNumber(String disbVchrPayeeAccountNumber) {
223            this.disbVchrPayeeAccountNumber = disbVchrPayeeAccountNumber;
224        }
225    
226        /**
227         * Gets the disbVchrCurrencyTypeName attribute.
228         * 
229         * @return Returns the disbVchrCurrencyTypeName
230         */
231        public String getDisbVchrCurrencyTypeName() {
232            return disbVchrCurrencyTypeName;
233        }
234    
235    
236        /**
237         * Sets the disbVchrCurrencyTypeName attribute.
238         * 
239         * @param disbVchrCurrencyTypeName The disbVchrCurrencyTypeName to set.
240         */
241        public void setDisbVchrCurrencyTypeName(String disbVchrCurrencyTypeName) {
242            this.disbVchrCurrencyTypeName = disbVchrCurrencyTypeName;
243        }
244    
245        /**
246         * Gets the disbursementVoucherForeignCurrencyTypeName attribute. This field is here because the currency type field is
247         * presented in different places on screen, and value conflicts occur unless we have an alias.
248         * 
249         * @return Returns the disbursementVoucherForeignCurrencyTypeName
250         */
251        public String getDisbursementVoucherForeignCurrencyTypeName() {
252            return disbursementVoucherForeignCurrencyTypeName;
253        }
254    
255    
256        /**
257         * Sets the disbursementVoucherForeignCurrencyTypeName attribute. This field is here because the currency type field is
258         * presented in different places on screen, and value conflicts occur unless we have an alias.
259         * 
260         * @param disbursementVoucherForeignCurrencyTypeName The disbursementVoucherForeignCurrencyTypeName to set.
261         */
262        public void setDisbursementVoucherForeignCurrencyTypeName(String disbursementVoucherForeignCurrencyTypeName) {
263            this.disbursementVoucherForeignCurrencyTypeName = disbursementVoucherForeignCurrencyTypeName;
264        }
265    
266        /**
267         * Gets the disbVchrCurrencyTypeCode attribute.
268         * 
269         * @return Returns the disbVchrCurrencyTypeCode
270         */
271        public String getDisbVchrCurrencyTypeCode() {
272            return disbVchrCurrencyTypeCode;
273        }
274    
275    
276        /**
277         * Sets the disbVchrCurrencyTypeCode attribute.
278         * 
279         * @param disbVchrCurrencyTypeCode The disbVchrCurrencyTypeCode to set.
280         */
281        public void setDisbVchrCurrencyTypeCode(String disbVchrCurrencyTypeCode) {
282            this.disbVchrCurrencyTypeCode = disbVchrCurrencyTypeCode;
283        }
284    
285        /**
286         * Gets the disbursementVoucherForeignCurrencyTypeCode attribute. This field is here because the currency type field is
287         * presented in different places on screen, and value conflicts occur unless we have an alias.
288         * 
289         * @return Returns the disbursementVoucherForeignCurrencyTypeCode
290         */
291        public String getDisbursementVoucherForeignCurrencyTypeCode() {
292            return disbursementVoucherForeignCurrencyTypeCode;
293        }
294    
295        /**
296         * Sets the disbursementVoucherForeignCurrencyTypeCode attribute. This field is here because the currency type field is
297         * presented in different places on screen, and value conflicts occur unless we have an alias.
298         * 
299         * @param disbursementVoucherForeignCurrencyTypeCode The disbursementVoucherForeignCurrencyTypeCode to set.
300         */
301        public void setDisbursementVoucherForeignCurrencyTypeCode(String disbursementVoucherForeignCurrencyTypeCode) {
302            this.disbursementVoucherForeignCurrencyTypeCode = disbursementVoucherForeignCurrencyTypeCode;
303        }
304    
305        /**
306         * Gets the disbursementVoucherWireTransferFeeWaiverIndicator attribute.
307         * 
308         * @return Returns the disbursementVoucherWireTransferFeeWaiverIndicator
309         */
310        public boolean isDisbursementVoucherWireTransferFeeWaiverIndicator() {
311            return disbursementVoucherWireTransferFeeWaiverIndicator;
312        }
313    
314    
315        /**
316         * Sets the disbursementVoucherWireTransferFeeWaiverIndicator attribute.
317         * 
318         * @param disbursementVoucherWireTransferFeeWaiverIndicator The disbursementVoucherWireTransferFeeWaiverIndicator to set.
319         */
320        public void setDisbursementVoucherWireTransferFeeWaiverIndicator(boolean disbursementVoucherWireTransferFeeWaiverIndicator) {
321            this.disbursementVoucherWireTransferFeeWaiverIndicator = disbursementVoucherWireTransferFeeWaiverIndicator;
322        }
323    
324        /**
325         * Gets the disbursementVoucherPayeeAccountName attribute.
326         * 
327         * @return Returns the disbursementVoucherPayeeAccountName
328         */
329        public String getDisbursementVoucherPayeeAccountName() {
330            return disbursementVoucherPayeeAccountName;
331        }
332    
333    
334        /**
335         * Sets the disbursementVoucherPayeeAccountName attribute.
336         * 
337         * @param disbursementVoucherPayeeAccountName The disbursementVoucherPayeeAccountName to set.
338         */
339        public void setDisbursementVoucherPayeeAccountName(String disbursementVoucherPayeeAccountName) {
340            this.disbursementVoucherPayeeAccountName = disbursementVoucherPayeeAccountName;
341        }
342    
343        /**
344         * Gets the disbursementVoucherPayeeAccountTypeCode attribute.
345         * 
346         * @return Returns the disbursementVoucherPayeeAccountTypeCode
347         */
348        public String getDisbursementVoucherPayeeAccountTypeCode() {
349            return disbursementVoucherPayeeAccountTypeCode;
350        }
351    
352    
353        /**
354         * Sets the disbursementVoucherPayeeAccountTypeCode attribute.
355         * 
356         * @param disbursementVoucherPayeeAccountTypeCode The disbursementVoucherPayeeAccountTypeCode to set.
357         */
358        public void setDisbursementVoucherPayeeAccountTypeCode(String disbursementVoucherPayeeAccountTypeCode) {
359            this.disbursementVoucherPayeeAccountTypeCode = disbursementVoucherPayeeAccountTypeCode;
360        }
361    
362        /**
363         * Gets the disbursementVoucherAutomatedClearingHouseProfileNumber attribute.
364         * 
365         * @return Returns the disbursementVoucherAutomatedClearingHouseProfileNumber
366         */
367        public String getDisbursementVoucherAutomatedClearingHouseProfileNumber() {
368            return disbursementVoucherAutomatedClearingHouseProfileNumber;
369        }
370    
371    
372        /**
373         * Sets the disbursementVoucherAutomatedClearingHouseProfileNumber attribute.
374         * 
375         * @param disbursementVoucherAutomatedClearingHouseProfileNumber The disbursementVoucherAutomatedClearingHouseProfileNumber to
376         *        set.
377         */
378        public void setDisbursementVoucherAutomatedClearingHouseProfileNumber(String disbursementVoucherAutomatedClearingHouseProfileNumber) {
379            this.disbursementVoucherAutomatedClearingHouseProfileNumber = disbursementVoucherAutomatedClearingHouseProfileNumber;
380        }
381    
382        public void setDisbVchrForeignBankIndicatorName(String name) {
383        }
384    
385        /**
386         * @see org.kuali.rice.kns.bo.BusinessObjectBase#toStringMapper()
387         */
388        protected LinkedHashMap toStringMapper() {
389            LinkedHashMap m = new LinkedHashMap();
390            m.put(KFSPropertyConstants.DOCUMENT_NUMBER, this.documentNumber);
391            return m;
392        }
393    
394    }