View Javadoc
1   /*
2    * The Kuali Financial System, a comprehensive financial management system for higher education.
3    * 
4    * Copyright 2005-2014 The Kuali Foundation
5    * 
6    * This program is free software: you can redistribute it and/or modify
7    * it under the terms of the GNU Affero General Public License as
8    * published by the Free Software Foundation, either version 3 of the
9    * License, or (at your option) any later version.
10   * 
11   * This program is distributed in the hope that it will be useful,
12   * but WITHOUT ANY WARRANTY; without even the implied warranty of
13   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14   * GNU Affero General Public License for more details.
15   * 
16   * You should have received a copy of the GNU Affero General Public License
17   * along with this program.  If not, see <http://www.gnu.org/licenses/>.
18   */
19  package org.kuali.kfs.sys.businessobject;
20  
21  import org.kuali.kfs.coa.businessobject.Account;
22  import org.kuali.kfs.coa.businessobject.Chart;
23  import org.kuali.kfs.coa.businessobject.ObjectCode;
24  import org.kuali.kfs.coa.businessobject.SubAccount;
25  import org.kuali.kfs.coa.businessobject.SubObjectCode;
26  import org.kuali.kfs.sys.KFSConstants;
27  import org.kuali.rice.core.api.mo.common.active.MutableInactivatable;
28  import org.kuali.rice.krad.bo.PersistableBusinessObjectBase;
29  
30  /**
31   * Bank Business Object
32   */
33  public class Bank extends PersistableBusinessObjectBase implements MutableInactivatable {
34      public static final String CACHE_NAME = KFSConstants.APPLICATION_NAMESPACE_CODE + "/" + "Bank";
35  
36      protected String bankCode;
37      protected String bankName;
38      protected String bankShortName;
39      protected String bankRoutingNumber;
40      protected String bankAccountNumber;
41      protected String bankAccountDescription;
42      protected String cashOffsetFinancialChartOfAccountCode;
43      protected String cashOffsetAccountNumber;
44      protected String cashOffsetSubAccountNumber;
45      protected String cashOffsetObjectCode;
46      protected String cashOffsetSubObjectCode;
47      protected String continuationBankCode;
48      protected boolean bankDepositIndicator;
49      protected boolean bankDisbursementIndicator;
50      protected boolean bankAchIndicator;
51      protected boolean bankCheckIndicator;
52      protected boolean active;
53  
54      protected Chart cashOffsetFinancialChartOfAccount;
55      protected Account cashOffsetAccount;
56      protected ObjectCode cashOffsetObject;
57      protected SubAccount cashOffsetSubAccount;
58      protected SubObjectCode cashOffsetSubObject;
59      protected Bank continuationBank;
60  
61      /**
62       * Default no-arg constructor.
63       */
64  
65      public Bank() {
66          super();
67      }
68  
69      /**
70       * Gets the bankCode attribute.
71       *
72       * @return Returns the bankCode.
73       */
74      public String getBankCode() {
75          return bankCode;
76      }
77  
78  
79      /**
80       * Sets the bankCode attribute value.
81       *
82       * @param bankCode The bankCode to set.
83       */
84      public void setBankCode(String bankCode) {
85          this.bankCode = bankCode;
86      }
87  
88  
89      /**
90       * Gets the bankName attribute.
91       *
92       * @return Returns the bankName.
93       */
94      public String getBankName() {
95          return bankName;
96      }
97  
98  
99      /**
100      * Sets the bankName attribute value.
101      *
102      * @param bankName The bankName to set.
103      */
104     public void setBankName(String bankName) {
105         this.bankName = bankName;
106     }
107 
108 
109     /**
110      * Gets the bankShortName attribute.
111      *
112      * @return Returns the bankShortName.
113      */
114     public String getBankShortName() {
115         return bankShortName;
116     }
117 
118 
119     /**
120      * Sets the bankShortName attribute value.
121      *
122      * @param bankShortName The bankShortName to set.
123      */
124     public void setBankShortName(String bankShortName) {
125         this.bankShortName = bankShortName;
126     }
127 
128 
129     /**
130      * Gets the bankRoutingNumber attribute.
131      *
132      * @return Returns the bankRoutingNumber.
133      */
134     public String getBankRoutingNumber() {
135         return bankRoutingNumber;
136     }
137 
138 
139     /**
140      * Sets the bankRoutingNumber attribute value.
141      *
142      * @param bankRoutingNumber The bankRoutingNumber to set.
143      */
144     public void setBankRoutingNumber(String bankRoutingNumber) {
145         this.bankRoutingNumber = bankRoutingNumber;
146     }
147 
148 
149     /**
150      * Gets the bankAccountNumber attribute.
151      *
152      * @return Returns the bankAccountNumber.
153      */
154     public String getBankAccountNumber() {
155         return bankAccountNumber;
156     }
157 
158 
159     /**
160      * Sets the bankAccountNumber attribute value.
161      *
162      * @param bankAccountNumber The bankAccountNumber to set.
163      */
164     public void setBankAccountNumber(String bankAccountNumber) {
165         this.bankAccountNumber = bankAccountNumber;
166     }
167 
168 
169     /**
170      * Gets the bankAccountDescription attribute.
171      *
172      * @return Returns the bankAccountDescription.
173      */
174     public String getBankAccountDescription() {
175         return bankAccountDescription;
176     }
177 
178 
179     /**
180      * Sets the bankAccountDescription attribute value.
181      *
182      * @param bankAccountDescription The bankAccountDescription to set.
183      */
184     public void setBankAccountDescription(String bankAccountDescription) {
185         this.bankAccountDescription = bankAccountDescription;
186     }
187 
188 
189     /**
190      * Gets the cashOffsetFinancialChartOfAccountCode attribute.
191      *
192      * @return Returns the cashOffsetFinancialChartOfAccountCode.
193      */
194     public String getCashOffsetFinancialChartOfAccountCode() {
195         return cashOffsetFinancialChartOfAccountCode;
196     }
197 
198 
199     /**
200      * Sets the cashOffsetFinancialChartOfAccountCode attribute value.
201      *
202      * @param cashOffsetFinancialChartOfAccountCode The cashOffsetFinancialChartOfAccountCode to set.
203      */
204     public void setCashOffsetFinancialChartOfAccountCode(String cashOffsetFinancialChartOfAccountCode) {
205         this.cashOffsetFinancialChartOfAccountCode = cashOffsetFinancialChartOfAccountCode;
206     }
207 
208 
209     /**
210      * Gets the cashOffsetAccountNumber attribute.
211      *
212      * @return Returns the cashOffsetAccountNumber.
213      */
214     public String getCashOffsetAccountNumber() {
215         return cashOffsetAccountNumber;
216     }
217 
218 
219     /**
220      * Sets the cashOffsetAccountNumber attribute value.
221      *
222      * @param cashOffsetAccountNumber The cashOffsetAccountNumber to set.
223      */
224     public void setCashOffsetAccountNumber(String cashOffsetAccountNumber) {
225         this.cashOffsetAccountNumber = cashOffsetAccountNumber;
226     }
227 
228 
229     /**
230      * Gets the cashOffsetSubAccountNumber attribute.
231      *
232      * @return Returns the cashOffsetSubAccountNumber.
233      */
234     public String getCashOffsetSubAccountNumber() {
235         return cashOffsetSubAccountNumber;
236     }
237 
238 
239     /**
240      * Sets the cashOffsetSubAccountNumber attribute value.
241      *
242      * @param cashOffsetSubAccountNumber The cashOffsetSubAccountNumber to set.
243      */
244     public void setCashOffsetSubAccountNumber(String cashOffsetSubAccountNumber) {
245         this.cashOffsetSubAccountNumber = cashOffsetSubAccountNumber;
246     }
247 
248 
249     /**
250      * Gets the cashOffsetObjectCode attribute.
251      *
252      * @return Returns the cashOffsetObjectCode.
253      */
254     public String getCashOffsetObjectCode() {
255         return cashOffsetObjectCode;
256     }
257 
258 
259     /**
260      * Sets the cashOffsetObjectCode attribute value.
261      *
262      * @param cashOffsetObjectCode The cashOffsetObjectCode to set.
263      */
264     public void setCashOffsetObjectCode(String cashOffsetObjectCode) {
265         this.cashOffsetObjectCode = cashOffsetObjectCode;
266     }
267 
268 
269     /**
270      * Gets the cashOffsetSubObjectCode attribute.
271      *
272      * @return Returns the cashOffsetSubObjectCode.
273      */
274     public String getCashOffsetSubObjectCode() {
275         return cashOffsetSubObjectCode;
276     }
277 
278 
279     /**
280      * Sets the cashOffsetSubObjectCode attribute value.
281      *
282      * @param cashOffsetSubObjectCode The cashOffsetSubObjectCode to set.
283      */
284     public void setCashOffsetSubObjectCode(String cashOffsetSubObjectCode) {
285         this.cashOffsetSubObjectCode = cashOffsetSubObjectCode;
286     }
287 
288 
289     /**
290      * Gets the bankDepositIndicator attribute.
291      *
292      * @return Returns the bankDepositIndicator.
293      */
294     public boolean isBankDepositIndicator() {
295         return bankDepositIndicator;
296     }
297 
298 
299     /**
300      * Sets the bankDepositIndicator attribute value.
301      *
302      * @param bankDepositIndicator The bankDepositIndicator to set.
303      */
304     public void setBankDepositIndicator(boolean bankDepositIndicator) {
305         this.bankDepositIndicator = bankDepositIndicator;
306     }
307 
308 
309     /**
310      * Gets the bankDisbursementIndicator attribute.
311      *
312      * @return Returns the bankDisbursementIndicator.
313      */
314     public boolean isBankDisbursementIndicator() {
315         return bankDisbursementIndicator;
316     }
317 
318 
319     /**
320      * Sets the bankDisbursementIndicator attribute value.
321      *
322      * @param bankDisbursementIndicator The bankDisbursementIndicator to set.
323      */
324     public void setBankDisbursementIndicator(boolean bankDisbursementIndicator) {
325         this.bankDisbursementIndicator = bankDisbursementIndicator;
326     }
327 
328 
329     /**
330      * Gets the bankAchIndicator attribute.
331      *
332      * @return Returns the bankAchIndicator.
333      */
334     public boolean isBankAchIndicator() {
335         return bankAchIndicator;
336     }
337 
338 
339     /**
340      * Sets the bankAchIndicator attribute value.
341      *
342      * @param bankAchIndicator The bankAchIndicator to set.
343      */
344     public void setBankAchIndicator(boolean bankAchIndicator) {
345         this.bankAchIndicator = bankAchIndicator;
346     }
347 
348 
349     /**
350      * Gets the bankCheckIndicator attribute.
351      *
352      * @return Returns the bankCheckIndicator.
353      */
354     public boolean isBankCheckIndicator() {
355         return bankCheckIndicator;
356     }
357 
358 
359     /**
360      * Sets the bankCheckIndicator attribute value.
361      *
362      * @param bankCheckIndicator The bankCheckIndicator to set.
363      */
364     public void setBankCheckIndicator(boolean bankCheckIndicator) {
365         this.bankCheckIndicator = bankCheckIndicator;
366     }
367 
368 
369     /**
370      * Gets the active attribute.
371      *
372      * @return Returns the active.
373      */
374     @Override
375     public boolean isActive() {
376         return active;
377     }
378 
379 
380     /**
381      * Sets the active attribute value.
382      *
383      * @param active The active to set.
384      */
385     @Override
386     public void setActive(boolean active) {
387         this.active = active;
388     }
389 
390     /**
391      * Gets the cashOffsetFinancialChartOfAccount attribute.
392      *
393      * @return Returns the cashOffsetFinancialChartOfAccount.
394      */
395     public Chart getCashOffsetFinancialChartOfAccount() {
396         return cashOffsetFinancialChartOfAccount;
397     }
398 
399     /**
400      * Sets the cashOffsetFinancialChartOfAccount attribute value.
401      *
402      * @param cashOffsetFinancialChartOfAccount The cashOffsetFinancialChartOfAccount to set.
403      */
404     public void setCashOffsetFinancialChartOfAccount(Chart cashOffsetFinancialChartOfAccount) {
405         this.cashOffsetFinancialChartOfAccount = cashOffsetFinancialChartOfAccount;
406     }
407 
408     /**
409      * Gets the cashOffsetAccount attribute.
410      *
411      * @return Returns the cashOffsetAccount.
412      */
413     public Account getCashOffsetAccount() {
414         return cashOffsetAccount;
415     }
416 
417     /**
418      * Sets the cashOffsetAccount attribute value.
419      *
420      * @param cashOffsetAccount The cashOffsetAccount to set.
421      */
422     public void setCashOffsetAccount(Account cashOffsetAccount) {
423         this.cashOffsetAccount = cashOffsetAccount;
424     }
425 
426     /**
427      * Gets the cashOffsetObject attribute.
428      *
429      * @return Returns the cashOffsetObject.
430      */
431     public ObjectCode getCashOffsetObject() {
432         return cashOffsetObject;
433     }
434 
435     /**
436      * Sets the cashOffsetObject attribute value.
437      *
438      * @param cashOffsetObject The cashOffsetObject to set.
439      */
440     public void setCashOffsetObject(ObjectCode cashOffsetObject) {
441         this.cashOffsetObject = cashOffsetObject;
442     }
443 
444     /**
445      * Gets the cashOffsetSubAccount attribute.
446      *
447      * @return Returns the cashOffsetSubAccount.
448      */
449     public SubAccount getCashOffsetSubAccount() {
450         return cashOffsetSubAccount;
451     }
452 
453     /**
454      * Sets the cashOffsetSubAccount attribute value.
455      *
456      * @param cashOffsetSubAccount The cashOffsetSubAccount to set.
457      */
458     public void setCashOffsetSubAccount(SubAccount cashOffsetSubAccount) {
459         this.cashOffsetSubAccount = cashOffsetSubAccount;
460     }
461 
462     /**
463      * Gets the cashOffsetSubObject attribute.
464      *
465      * @return Returns the cashOffsetSubObject.
466      */
467     public SubObjectCode getCashOffsetSubObject() {
468         return cashOffsetSubObject;
469     }
470 
471     /**
472      * Sets the cashOffsetSubObject attribute value.
473      *
474      * @param cashOffsetSubObject The cashOffsetSubObject to set.
475      */
476     public void setCashOffsetSubObject(SubObjectCode cashOffsetSubObject) {
477         this.cashOffsetSubObject = cashOffsetSubObject;
478     }
479 
480     /**
481      * Gets the continuationBankCode attribute.
482      *
483      * @return Returns the continuationBankCode.
484      */
485     public String getContinuationBankCode() {
486         return continuationBankCode;
487     }
488 
489     /**
490      * Sets the continuationBankCode attribute value.
491      *
492      * @param continuationBankCode The continuationBankCode to set.
493      */
494     public void setContinuationBankCode(String continuationBankCode) {
495         this.continuationBankCode = continuationBankCode;
496     }
497 
498     /**
499      * Gets the continuationBank attribute.
500      *
501      * @return Returns the continuationBank.
502      */
503     public Bank getContinuationBank() {
504         return continuationBank;
505     }
506 
507     /**
508      * Sets the continuationBank attribute value.
509      *
510      * @param continuationBank The continuationBank to set.
511      */
512     public void setContinuationBank(Bank continuationBank) {
513         this.continuationBank = continuationBank;
514     }
515 
516 }