001: /*
002: * Copyright 2005-2007 The Kuali Foundation.
003: *
004: * Licensed under the Educational Community License, Version 1.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/ecl1.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.module.financial.bo;
018:
019: import java.util.LinkedHashMap;
020:
021: import org.kuali.core.bo.PersistableBusinessObjectBase;
022: import org.kuali.kfs.KFSPropertyConstants;
023: import org.kuali.module.financial.lookup.keyvalues.PayeeTypeValuesFinder;
024: import org.kuali.module.financial.lookup.keyvalues.PaymentReasonValuesFinder;
025: import org.kuali.module.financial.rules.DisbursementVoucherRuleConstants;
026:
027: /**
028: * This class is used to represent a disbursement voucher payee detail.
029: */
030: public class DisbursementVoucherPayeeDetail extends
031: PersistableBusinessObjectBase {
032:
033: private String documentNumber;
034: private String disbVchrPaymentReasonCode;
035: private boolean disbVchrAlienPaymentCode;
036: private String disbVchrPayeeIdNumber;
037: private String disbVchrPayeePersonName;
038: private String disbVchrPayeeLine1Addr;
039: private String disbVchrPayeeLine2Addr;
040: private String disbVchrPayeeCityName;
041: private String disbVchrPayeeStateCode;
042: private String disbVchrPayeeZipCode;
043: private String disbVchrPayeeCountryCode;
044: private String disbVchrRemitPersonName;
045: private String disbVchrRemitLine1Addr;
046: private String disbVchrRemitLine2Addr;
047: private String disbVchrRemitCityName;
048: private String disbVchrRemitStateCode;
049: private String disbVchrRemitZipCode;
050: private String disbVchrRemitCountryCode;
051: private boolean disbVchrPayeeEmployeeCode;
052: private boolean dvPayeeRevolvingFundCode;
053: private String disbursementVoucherPayeeTypeCode;
054:
055: private PaymentReasonCode disbVchrPaymentReason;
056:
057: /**
058: * Default no-arg constructor.
059: */
060: public DisbursementVoucherPayeeDetail() {
061:
062: }
063:
064: /**
065: * Gets the documentNumber attribute.
066: *
067: * @return Returns the documentNumber
068: */
069: public String getDocumentNumber() {
070: return documentNumber;
071: }
072:
073: /**
074: * Sets the documentNumber attribute.
075: *
076: * @param documentNumber The documentNumber to set.
077: */
078: public void setDocumentNumber(String documentNumber) {
079: this .documentNumber = documentNumber;
080: }
081:
082: /**
083: * Gets the disbVchrPaymentReasonCode attribute.
084: *
085: * @return Returns the disbVchrPaymentReasonCode
086: */
087: public String getDisbVchrPaymentReasonCode() {
088: return disbVchrPaymentReasonCode;
089: }
090:
091: /**
092: * Sets the disbVchrPaymentReasonCode attribute.
093: *
094: * @param disbVchrPaymentReasonCode The disbVchrPaymentReasonCode to set.
095: */
096: public void setDisbVchrPaymentReasonCode(
097: String disbVchrPaymentReasonCode) {
098: this .disbVchrPaymentReasonCode = disbVchrPaymentReasonCode;
099: }
100:
101: /**
102: * Gets the disbVchrAlienPaymentCode attribute.
103: *
104: * @return Returns the disbVchrAlienPaymentCode
105: */
106: public boolean isDisbVchrAlienPaymentCode() {
107: return disbVchrAlienPaymentCode;
108: }
109:
110: /**
111: * Sets the disbVchrAlienPaymentCode attribute.
112: *
113: * @param disbVchrAlienPaymentCode The disbVchrAlienPaymentCode to set.
114: */
115: public void setDisbVchrAlienPaymentCode(
116: boolean disbVchrAlienPaymentCode) {
117: this .disbVchrAlienPaymentCode = disbVchrAlienPaymentCode;
118: }
119:
120: /**
121: * Gets the disbVchrPayeeIdNumber attribute.
122: *
123: * @return Returns the disbVchrPayeeIdNumber
124: */
125: public String getDisbVchrPayeeIdNumber() {
126: return disbVchrPayeeIdNumber;
127: }
128:
129: /**
130: * Sets the disbVchrPayeeIdNumber attribute.
131: *
132: * @param disbVchrPayeeIdNumber The disbVchrPayeeIdNumber to set.
133: */
134: public void setDisbVchrPayeeIdNumber(String disbVchrPayeeIdNumber) {
135: this .disbVchrPayeeIdNumber = disbVchrPayeeIdNumber;
136: }
137:
138: /**
139: * Gets the disbVchrPayeePersonName attribute.
140: *
141: * @return Returns the disbVchrPayeePersonName
142: */
143: public String getDisbVchrPayeePersonName() {
144: return disbVchrPayeePersonName;
145: }
146:
147: /**
148: * Sets the disbVchrPayeePersonName attribute.
149: *
150: * @param disbVchrPayeePersonName The disbVchrPayeePersonName to set.
151: */
152: public void setDisbVchrPayeePersonName(
153: String disbVchrPayeePersonName) {
154: this .disbVchrPayeePersonName = disbVchrPayeePersonName;
155: }
156:
157: /**
158: * Gets the disbVchrPayeeLine1Addr attribute.
159: *
160: * @return Returns the disbVchrPayeeLine1Addr
161: */
162: public String getDisbVchrPayeeLine1Addr() {
163: return disbVchrPayeeLine1Addr;
164: }
165:
166: /**
167: * Sets the disbVchrPayeeLine1Addr attribute.
168: *
169: * @param disbVchrPayeeLine1Addr The disbVchrPayeeLine1Addr to set.
170: */
171: public void setDisbVchrPayeeLine1Addr(String disbVchrPayeeLine1Addr) {
172: this .disbVchrPayeeLine1Addr = disbVchrPayeeLine1Addr;
173: }
174:
175: /**
176: * Gets the disbVchrPayeeLine2Addr attribute.
177: *
178: * @return Returns the disbVchrPayeeLine2Addr
179: */
180: public String getDisbVchrPayeeLine2Addr() {
181: return disbVchrPayeeLine2Addr;
182: }
183:
184: /**
185: * Sets the disbVchrPayeeLine2Addr attribute.
186: *
187: * @param disbVchrPayeeLine2Addr The disbVchrPayeeLine2Addr to set.
188: */
189: public void setDisbVchrPayeeLine2Addr(String disbVchrPayeeLine2Addr) {
190: this .disbVchrPayeeLine2Addr = disbVchrPayeeLine2Addr;
191: }
192:
193: /**
194: * Gets the disbVchrPayeeCityName attribute.
195: *
196: * @return Returns the disbVchrPayeeCityName
197: */
198: public String getDisbVchrPayeeCityName() {
199: return disbVchrPayeeCityName;
200: }
201:
202: /**
203: * Sets the disbVchrPayeeCityName attribute.
204: *
205: * @param disbVchrPayeeCityName The disbVchrPayeeCityName to set.
206: */
207: public void setDisbVchrPayeeCityName(String disbVchrPayeeCityName) {
208: this .disbVchrPayeeCityName = disbVchrPayeeCityName;
209: }
210:
211: /**
212: * Gets the disbVchrPayeeStateCode attribute.
213: *
214: * @return Returns the disbVchrPayeeStateCode
215: */
216: public String getDisbVchrPayeeStateCode() {
217: return disbVchrPayeeStateCode;
218: }
219:
220: /**
221: * Sets the disbVchrPayeeStateCode attribute.
222: *
223: * @param disbVchrPayeeStateCode The disbVchrPayeeStateCode to set.
224: */
225: public void setDisbVchrPayeeStateCode(String disbVchrPayeeStateCode) {
226: this .disbVchrPayeeStateCode = disbVchrPayeeStateCode;
227: }
228:
229: /**
230: * Gets the disbVchrPayeeZipCode attribute.
231: *
232: * @return Returns the disbVchrPayeeZipCode
233: */
234: public String getDisbVchrPayeeZipCode() {
235: return disbVchrPayeeZipCode;
236: }
237:
238: /**
239: * Sets the disbVchrPayeeZipCode attribute.
240: *
241: * @param disbVchrPayeeZipCode The disbVchrPayeeZipCode to set.
242: */
243: public void setDisbVchrPayeeZipCode(String disbVchrPayeeZipCode) {
244: this .disbVchrPayeeZipCode = disbVchrPayeeZipCode;
245: }
246:
247: /**
248: * Gets the disbVchrPayeeCountryCode attribute.
249: *
250: * @return Returns the disbVchrPayeeCountryCode
251: */
252: public String getDisbVchrPayeeCountryCode() {
253: return disbVchrPayeeCountryCode;
254: }
255:
256: /**
257: * Sets the disbVchrPayeeCountryCode attribute.
258: *
259: * @param disbVchrPayeeCountryCode The disbVchrPayeeCountryCode to set.
260: */
261: public void setDisbVchrPayeeCountryCode(
262: String disbVchrPayeeCountryCode) {
263: this .disbVchrPayeeCountryCode = disbVchrPayeeCountryCode;
264: }
265:
266: /**
267: * Gets the disbVchrRemitPersonName attribute.
268: *
269: * @return Returns the disbVchrRemitPersonName
270: */
271: public String getDisbVchrRemitPersonName() {
272: return disbVchrRemitPersonName;
273: }
274:
275: /**
276: * Sets the disbVchrRemitPersonName attribute.
277: *
278: * @param disbVchrRemitPersonName The disbVchrRemitPersonName to set.
279: */
280: public void setDisbVchrRemitPersonName(
281: String disbVchrRemitPersonName) {
282: this .disbVchrRemitPersonName = disbVchrRemitPersonName;
283: }
284:
285: /**
286: * Gets the disbVchrRemitLine1Addr attribute.
287: *
288: * @return Returns the disbVchrRemitLine1Addr
289: */
290: public String getDisbVchrRemitLine1Addr() {
291: return disbVchrRemitLine1Addr;
292: }
293:
294: /**
295: * Sets the disbVchrRemitLine1Addr attribute.
296: *
297: * @param disbVchrRemitLine1Addr The disbVchrRemitLine1Addr to set.
298: */
299: public void setDisbVchrRemitLine1Addr(String disbVchrRemitLine1Addr) {
300: this .disbVchrRemitLine1Addr = disbVchrRemitLine1Addr;
301: }
302:
303: /**
304: * Gets the disbVchrRemitLine2Addr attribute.
305: *
306: * @return Returns the disbVchrRemitLine2Addr
307: */
308: public String getDisbVchrRemitLine2Addr() {
309: return disbVchrRemitLine2Addr;
310: }
311:
312: /**
313: * Sets the disbVchrRemitLine2Addr attribute.
314: *
315: * @param disbVchrRemitLine2Addr The disbVchrRemitLine2Addr to set.
316: */
317: public void setDisbVchrRemitLine2Addr(String disbVchrRemitLine2Addr) {
318: this .disbVchrRemitLine2Addr = disbVchrRemitLine2Addr;
319: }
320:
321: /**
322: * Gets the disbVchrRemitCityName attribute.
323: *
324: * @return Returns the disbVchrRemitCityName
325: */
326: public String getDisbVchrRemitCityName() {
327: return disbVchrRemitCityName;
328: }
329:
330: /**
331: * Sets the disbVchrRemitCityName attribute.
332: *
333: * @param disbVchrRemitCityName The disbVchrRemitCityName to set.
334: */
335: public void setDisbVchrRemitCityName(String disbVchrRemitCityName) {
336: this .disbVchrRemitCityName = disbVchrRemitCityName;
337: }
338:
339: /**
340: * Gets the disbVchrRemitStateCode attribute.
341: *
342: * @return Returns the disbVchrRemitStateCode
343: */
344: public String getDisbVchrRemitStateCode() {
345: return disbVchrRemitStateCode;
346: }
347:
348: /**
349: * Sets the disbVchrRemitStateCode attribute.
350: *
351: * @param disbVchrRemitStateCode The disbVchrRemitStateCode to set.
352: */
353: public void setDisbVchrRemitStateCode(String disbVchrRemitStateCode) {
354: this .disbVchrRemitStateCode = disbVchrRemitStateCode;
355: }
356:
357: /**
358: * Gets the disbVchrRemitZipCode attribute.
359: *
360: * @return Returns the disbVchrRemitZipCode
361: */
362: public String getDisbVchrRemitZipCode() {
363: return disbVchrRemitZipCode;
364: }
365:
366: /**
367: * Sets the disbVchrRemitZipCode attribute.
368: *
369: * @param disbVchrRemitZipCode The disbVchrRemitZipCode to set.
370: */
371: public void setDisbVchrRemitZipCode(String disbVchrRemitZipCode) {
372: this .disbVchrRemitZipCode = disbVchrRemitZipCode;
373: }
374:
375: /**
376: * Gets the disbVchrRemitCountryCode attribute.
377: *
378: * @return Returns the disbVchrRemitCountryCode
379: */
380: public String getDisbVchrRemitCountryCode() {
381: return disbVchrRemitCountryCode;
382: }
383:
384: /**
385: * Sets the disbVchrRemitCountryCode attribute.
386: *
387: * @param disbVchrRemitCountryCode The disbVchrRemitCountryCode to set.
388: */
389: public void setDisbVchrRemitCountryCode(
390: String disbVchrRemitCountryCode) {
391: this .disbVchrRemitCountryCode = disbVchrRemitCountryCode;
392: }
393:
394: /**
395: * Gets the disbVchrPayeeEmployeeCode attribute.
396: *
397: * @return Returns the disbVchrPayeeEmployeeCode
398: */
399: public boolean isDisbVchrPayeeEmployeeCode() {
400: return disbVchrPayeeEmployeeCode;
401: }
402:
403: /**
404: * Sets the disbVchrPayeeEmployeeCode attribute.
405: *
406: * @param disbVchrPayeeEmployeeCode The disbVchrPayeeEmployeeCode to set.
407: */
408: public void setDisbVchrPayeeEmployeeCode(
409: boolean disbVchrPayeeEmployeeCode) {
410: this .disbVchrPayeeEmployeeCode = disbVchrPayeeEmployeeCode;
411: }
412:
413: /**
414: * Gets the dvPayeeRevolvingFundCode attribute.
415: *
416: * @return Returns the dvPayeeRevolvingFundCode
417: */
418: public boolean isDvPayeeRevolvingFundCode() {
419: return dvPayeeRevolvingFundCode;
420: }
421:
422: /**
423: * Sets the dvPayeeRevolvingFundCode attribute.
424: *
425: * @param dvPayeeRevolvingFundCode The dvPayeeRevolvingFundCode to set.
426: */
427: public void setDvPayeeRevolvingFundCode(
428: boolean dvPayeeRevolvingFundCode) {
429: this .dvPayeeRevolvingFundCode = dvPayeeRevolvingFundCode;
430: }
431:
432: /**
433: * Gets the disbVchrPaymentReason attribute.
434: *
435: * @return Returns the disbVchrPaymentReason
436: */
437: public PaymentReasonCode getDisbVchrPaymentReason() {
438: return disbVchrPaymentReason;
439: }
440:
441: /**
442: * Sets the disbVchrPaymentReason attribute.
443: *
444: * @param disbVchrPaymentReason The disbVchrPaymentReason to set.
445: * @deprecated
446: */
447: public void setDisbVchrPaymentReason(
448: PaymentReasonCode disbVchrPaymentReason) {
449: this .disbVchrPaymentReason = disbVchrPaymentReason;
450: }
451:
452: /**
453: * Checks the payee type code for vendor type
454: *
455: * @return
456: */
457: public boolean isVendor() {
458: return DisbursementVoucherRuleConstants.DV_PAYEE_TYPE_VENDOR
459: .equals(disbursementVoucherPayeeTypeCode);
460: }
461:
462: /**
463: * Checks the payee type code for dv payee type
464: *
465: * @return
466: */
467: public boolean isPayee() {
468: return DisbursementVoucherRuleConstants.DV_PAYEE_TYPE_PAYEE
469: .equals(disbursementVoucherPayeeTypeCode);
470: }
471:
472: /**
473: * Checks the payee type code for employee type
474: *
475: * @return
476: */
477: public boolean isEmployee() {
478: return DisbursementVoucherRuleConstants.DV_PAYEE_TYPE_EMPLOYEE
479: .equals(disbursementVoucherPayeeTypeCode);
480: }
481:
482: /**
483: * @return Returns the disbursementVoucherPayeeTypeCode.
484: */
485: public String getDisbursementVoucherPayeeTypeCode() {
486: return disbursementVoucherPayeeTypeCode;
487: }
488:
489: /**
490: * @param disbursementVoucherPayeeTypeCode The disbursementVoucherPayeeTypeCode to set.
491: */
492: public void setDisbursementVoucherPayeeTypeCode(
493: String disbursementVoucherPayeeTypeCode) {
494: this .disbursementVoucherPayeeTypeCode = disbursementVoucherPayeeTypeCode;
495: }
496:
497: /**
498: * returns the payee type name
499: */
500: public String getDisbursementVoucherPayeeTypeName() {
501: return new PayeeTypeValuesFinder()
502: .getKeyLabel(disbursementVoucherPayeeTypeCode);
503: }
504:
505: /**
506: *
507: * This method is a dummy method defined for OJB.
508: * @param name
509: */
510: public void setDisbursementVoucherPayeeTypeName(String name) {
511: }
512:
513: /**
514: * Returns the name associated with the payment reason name
515: *
516: * @return
517: */
518: public String getDisbVchrPaymentReasonName() {
519: return new PaymentReasonValuesFinder()
520: .getKeyLabel(disbVchrPaymentReasonCode);
521: }
522:
523: /**
524: * This method is a dummy method defined for OJB.
525: * @param name
526: */
527: public void setDisbVchrPaymentReasonName(String name) {
528: }
529:
530: /**
531: * @see org.kuali.core.bo.BusinessObjectBase#toStringMapper()
532: */
533: protected LinkedHashMap toStringMapper() {
534: LinkedHashMap m = new LinkedHashMap();
535: m
536: .put(KFSPropertyConstants.DOCUMENT_NUMBER,
537: this.documentNumber);
538: return m;
539: }
540: }
|