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.businessobject;
017    
018    import java.util.LinkedHashMap;
019    
020    import org.kuali.kfs.coa.businessobject.Account;
021    import org.kuali.kfs.coa.businessobject.Chart;
022    import org.kuali.kfs.coa.businessobject.ObjectCode;
023    import org.kuali.kfs.coa.businessobject.SubAccount;
024    import org.kuali.kfs.coa.businessobject.SubObjectCode;
025    import org.kuali.kfs.sys.KFSPropertyConstants;
026    import org.kuali.rice.kns.bo.Inactivateable;
027    import org.kuali.rice.kns.bo.PersistableBusinessObjectBase;
028    
029    /**
030     * Bank Business Object
031     */
032    public class Bank extends PersistableBusinessObjectBase implements Inactivateable {
033        private String bankCode;
034        private String bankName;
035        private String bankShortName;
036        private String bankRoutingNumber;
037        private String bankAccountNumber;
038        private String bankAccountDescription;
039        private String cashOffsetFinancialChartOfAccountCode;
040        private String cashOffsetAccountNumber;
041        private String cashOffsetSubAccountNumber;
042        private String cashOffsetObjectCode;
043        private String cashOffsetSubObjectCode;
044        private String continuationBankCode;
045        private boolean bankDepositIndicator;
046        private boolean bankDisbursementIndicator;
047        private boolean bankAchIndicator;
048        private boolean bankCheckIndicator;
049        private boolean active;
050    
051        private Chart cashOffsetFinancialChartOfAccount;
052        private Account cashOffsetAccount;
053        private ObjectCode cashOffsetObject;
054        private SubAccount cashOffsetSubAccount;
055        private SubObjectCode cashOffsetSubObject;
056        private Bank continuationBank;
057    
058        /**
059         * Default no-arg constructor.
060         */
061    
062        public Bank() {
063            super();
064        }
065    
066        /**
067         * Gets the bankCode attribute.
068         * 
069         * @return Returns the bankCode.
070         */
071        public String getBankCode() {
072            return bankCode;
073        }
074    
075    
076        /**
077         * Sets the bankCode attribute value.
078         * 
079         * @param bankCode The bankCode to set.
080         */
081        public void setBankCode(String bankCode) {
082            this.bankCode = bankCode;
083        }
084    
085    
086        /**
087         * Gets the bankName attribute.
088         * 
089         * @return Returns the bankName.
090         */
091        public String getBankName() {
092            return bankName;
093        }
094    
095    
096        /**
097         * Sets the bankName attribute value.
098         * 
099         * @param bankName The bankName to set.
100         */
101        public void setBankName(String bankName) {
102            this.bankName = bankName;
103        }
104    
105    
106        /**
107         * Gets the bankShortName attribute.
108         * 
109         * @return Returns the bankShortName.
110         */
111        public String getBankShortName() {
112            return bankShortName;
113        }
114    
115    
116        /**
117         * Sets the bankShortName attribute value.
118         * 
119         * @param bankShortName The bankShortName to set.
120         */
121        public void setBankShortName(String bankShortName) {
122            this.bankShortName = bankShortName;
123        }
124    
125    
126        /**
127         * Gets the bankRoutingNumber attribute.
128         * 
129         * @return Returns the bankRoutingNumber.
130         */
131        public String getBankRoutingNumber() {
132            return bankRoutingNumber;
133        }
134    
135    
136        /**
137         * Sets the bankRoutingNumber attribute value.
138         * 
139         * @param bankRoutingNumber The bankRoutingNumber to set.
140         */
141        public void setBankRoutingNumber(String bankRoutingNumber) {
142            this.bankRoutingNumber = bankRoutingNumber;
143        }
144    
145    
146        /**
147         * Gets the bankAccountNumber attribute.
148         * 
149         * @return Returns the bankAccountNumber.
150         */
151        public String getBankAccountNumber() {
152            return bankAccountNumber;
153        }
154    
155    
156        /**
157         * Sets the bankAccountNumber attribute value.
158         * 
159         * @param bankAccountNumber The bankAccountNumber to set.
160         */
161        public void setBankAccountNumber(String bankAccountNumber) {
162            this.bankAccountNumber = bankAccountNumber;
163        }
164    
165    
166        /**
167         * Gets the bankAccountDescription attribute.
168         * 
169         * @return Returns the bankAccountDescription.
170         */
171        public String getBankAccountDescription() {
172            return bankAccountDescription;
173        }
174    
175    
176        /**
177         * Sets the bankAccountDescription attribute value.
178         * 
179         * @param bankAccountDescription The bankAccountDescription to set.
180         */
181        public void setBankAccountDescription(String bankAccountDescription) {
182            this.bankAccountDescription = bankAccountDescription;
183        }
184    
185    
186        /**
187         * Gets the cashOffsetFinancialChartOfAccountCode attribute.
188         * 
189         * @return Returns the cashOffsetFinancialChartOfAccountCode.
190         */
191        public String getCashOffsetFinancialChartOfAccountCode() {
192            return cashOffsetFinancialChartOfAccountCode;
193        }
194    
195    
196        /**
197         * Sets the cashOffsetFinancialChartOfAccountCode attribute value.
198         * 
199         * @param cashOffsetFinancialChartOfAccountCode The cashOffsetFinancialChartOfAccountCode to set.
200         */
201        public void setCashOffsetFinancialChartOfAccountCode(String cashOffsetFinancialChartOfAccountCode) {
202            this.cashOffsetFinancialChartOfAccountCode = cashOffsetFinancialChartOfAccountCode;
203        }
204    
205    
206        /**
207         * Gets the cashOffsetAccountNumber attribute.
208         * 
209         * @return Returns the cashOffsetAccountNumber.
210         */
211        public String getCashOffsetAccountNumber() {
212            return cashOffsetAccountNumber;
213        }
214    
215    
216        /**
217         * Sets the cashOffsetAccountNumber attribute value.
218         * 
219         * @param cashOffsetAccountNumber The cashOffsetAccountNumber to set.
220         */
221        public void setCashOffsetAccountNumber(String cashOffsetAccountNumber) {
222            this.cashOffsetAccountNumber = cashOffsetAccountNumber;
223        }
224    
225    
226        /**
227         * Gets the cashOffsetSubAccountNumber attribute.
228         * 
229         * @return Returns the cashOffsetSubAccountNumber.
230         */
231        public String getCashOffsetSubAccountNumber() {
232            return cashOffsetSubAccountNumber;
233        }
234    
235    
236        /**
237         * Sets the cashOffsetSubAccountNumber attribute value.
238         * 
239         * @param cashOffsetSubAccountNumber The cashOffsetSubAccountNumber to set.
240         */
241        public void setCashOffsetSubAccountNumber(String cashOffsetSubAccountNumber) {
242            this.cashOffsetSubAccountNumber = cashOffsetSubAccountNumber;
243        }
244    
245    
246        /**
247         * Gets the cashOffsetObjectCode attribute.
248         * 
249         * @return Returns the cashOffsetObjectCode.
250         */
251        public String getCashOffsetObjectCode() {
252            return cashOffsetObjectCode;
253        }
254    
255    
256        /**
257         * Sets the cashOffsetObjectCode attribute value.
258         * 
259         * @param cashOffsetObjectCode The cashOffsetObjectCode to set.
260         */
261        public void setCashOffsetObjectCode(String cashOffsetObjectCode) {
262            this.cashOffsetObjectCode = cashOffsetObjectCode;
263        }
264    
265    
266        /**
267         * Gets the cashOffsetSubObjectCode attribute.
268         * 
269         * @return Returns the cashOffsetSubObjectCode.
270         */
271        public String getCashOffsetSubObjectCode() {
272            return cashOffsetSubObjectCode;
273        }
274    
275    
276        /**
277         * Sets the cashOffsetSubObjectCode attribute value.
278         * 
279         * @param cashOffsetSubObjectCode The cashOffsetSubObjectCode to set.
280         */
281        public void setCashOffsetSubObjectCode(String cashOffsetSubObjectCode) {
282            this.cashOffsetSubObjectCode = cashOffsetSubObjectCode;
283        }
284    
285    
286        /**
287         * Gets the bankDepositIndicator attribute.
288         * 
289         * @return Returns the bankDepositIndicator.
290         */
291        public boolean isBankDepositIndicator() {
292            return bankDepositIndicator;
293        }
294    
295    
296        /**
297         * Sets the bankDepositIndicator attribute value.
298         * 
299         * @param bankDepositIndicator The bankDepositIndicator to set.
300         */
301        public void setBankDepositIndicator(boolean bankDepositIndicator) {
302            this.bankDepositIndicator = bankDepositIndicator;
303        }
304    
305    
306        /**
307         * Gets the bankDisbursementIndicator attribute.
308         * 
309         * @return Returns the bankDisbursementIndicator.
310         */
311        public boolean isBankDisbursementIndicator() {
312            return bankDisbursementIndicator;
313        }
314    
315    
316        /**
317         * Sets the bankDisbursementIndicator attribute value.
318         * 
319         * @param bankDisbursementIndicator The bankDisbursementIndicator to set.
320         */
321        public void setBankDisbursementIndicator(boolean bankDisbursementIndicator) {
322            this.bankDisbursementIndicator = bankDisbursementIndicator;
323        }
324    
325    
326        /**
327         * Gets the bankAchIndicator attribute.
328         * 
329         * @return Returns the bankAchIndicator.
330         */
331        public boolean isBankAchIndicator() {
332            return bankAchIndicator;
333        }
334    
335    
336        /**
337         * Sets the bankAchIndicator attribute value.
338         * 
339         * @param bankAchIndicator The bankAchIndicator to set.
340         */
341        public void setBankAchIndicator(boolean bankAchIndicator) {
342            this.bankAchIndicator = bankAchIndicator;
343        }
344    
345    
346        /**
347         * Gets the bankCheckIndicator attribute.
348         * 
349         * @return Returns the bankCheckIndicator.
350         */
351        public boolean isBankCheckIndicator() {
352            return bankCheckIndicator;
353        }
354    
355    
356        /**
357         * Sets the bankCheckIndicator attribute value.
358         * 
359         * @param bankCheckIndicator The bankCheckIndicator to set.
360         */
361        public void setBankCheckIndicator(boolean bankCheckIndicator) {
362            this.bankCheckIndicator = bankCheckIndicator;
363        }
364    
365    
366        /**
367         * Gets the active attribute.
368         * 
369         * @return Returns the active.
370         */
371        public boolean isActive() {
372            return active;
373        }
374    
375    
376        /**
377         * Sets the active attribute value.
378         * 
379         * @param active The active to set.
380         */
381        public void setActive(boolean active) {
382            this.active = active;
383        }
384    
385        /**
386         * Gets the cashOffsetFinancialChartOfAccount attribute.
387         * 
388         * @return Returns the cashOffsetFinancialChartOfAccount.
389         */
390        public Chart getCashOffsetFinancialChartOfAccount() {
391            return cashOffsetFinancialChartOfAccount;
392        }
393    
394        /**
395         * Sets the cashOffsetFinancialChartOfAccount attribute value.
396         * 
397         * @param cashOffsetFinancialChartOfAccount The cashOffsetFinancialChartOfAccount to set.
398         */
399        public void setCashOffsetFinancialChartOfAccount(Chart cashOffsetFinancialChartOfAccount) {
400            this.cashOffsetFinancialChartOfAccount = cashOffsetFinancialChartOfAccount;
401        }
402    
403        /**
404         * Gets the cashOffsetAccount attribute.
405         * 
406         * @return Returns the cashOffsetAccount.
407         */
408        public Account getCashOffsetAccount() {
409            return cashOffsetAccount;
410        }
411    
412        /**
413         * Sets the cashOffsetAccount attribute value.
414         * 
415         * @param cashOffsetAccount The cashOffsetAccount to set.
416         */
417        public void setCashOffsetAccount(Account cashOffsetAccount) {
418            this.cashOffsetAccount = cashOffsetAccount;
419        }
420    
421        /**
422         * Gets the cashOffsetObject attribute.
423         * 
424         * @return Returns the cashOffsetObject.
425         */
426        public ObjectCode getCashOffsetObject() {
427            return cashOffsetObject;
428        }
429    
430        /**
431         * Sets the cashOffsetObject attribute value.
432         * 
433         * @param cashOffsetObject The cashOffsetObject to set.
434         */
435        public void setCashOffsetObject(ObjectCode cashOffsetObject) {
436            this.cashOffsetObject = cashOffsetObject;
437        }
438    
439        /**
440         * Gets the cashOffsetSubAccount attribute.
441         * 
442         * @return Returns the cashOffsetSubAccount.
443         */
444        public SubAccount getCashOffsetSubAccount() {
445            return cashOffsetSubAccount;
446        }
447    
448        /**
449         * Sets the cashOffsetSubAccount attribute value.
450         * 
451         * @param cashOffsetSubAccount The cashOffsetSubAccount to set.
452         */
453        public void setCashOffsetSubAccount(SubAccount cashOffsetSubAccount) {
454            this.cashOffsetSubAccount = cashOffsetSubAccount;
455        }
456    
457        /**
458         * Gets the cashOffsetSubObject attribute.
459         * 
460         * @return Returns the cashOffsetSubObject.
461         */
462        public SubObjectCode getCashOffsetSubObject() {
463            return cashOffsetSubObject;
464        }
465    
466        /**
467         * Sets the cashOffsetSubObject attribute value.
468         * 
469         * @param cashOffsetSubObject The cashOffsetSubObject to set.
470         */
471        public void setCashOffsetSubObject(SubObjectCode cashOffsetSubObject) {
472            this.cashOffsetSubObject = cashOffsetSubObject;
473        }
474    
475        /**
476         * Gets the continuationBankCode attribute.
477         * 
478         * @return Returns the continuationBankCode.
479         */
480        public String getContinuationBankCode() {
481            return continuationBankCode;
482        }
483    
484        /**
485         * Sets the continuationBankCode attribute value.
486         * 
487         * @param continuationBankCode The continuationBankCode to set.
488         */
489        public void setContinuationBankCode(String continuationBankCode) {
490            this.continuationBankCode = continuationBankCode;
491        }
492    
493        /**
494         * Gets the continuationBank attribute.
495         * 
496         * @return Returns the continuationBank.
497         */
498        public Bank getContinuationBank() {
499            return continuationBank;
500        }
501    
502        /**
503         * Sets the continuationBank attribute value.
504         * 
505         * @param continuationBank The continuationBank to set.
506         */
507        public void setContinuationBank(Bank continuationBank) {
508            this.continuationBank = continuationBank;
509        }
510    
511        /**
512         * @see org.kuali.rice.kns.bo.BusinessObjectBase#toStringMapper()
513         */
514        protected LinkedHashMap toStringMapper() {
515            LinkedHashMap m = new LinkedHashMap();
516    
517            m.put(KFSPropertyConstants.BANK_CODE, this.getBankCode());
518    
519            return m;
520        }
521    
522    }