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  
20  package org.kuali.kfs.module.bc.businessobject;
21  
22  import java.util.LinkedHashMap;
23  
24  import org.kuali.kfs.coa.businessobject.Account;
25  import org.kuali.kfs.coa.businessobject.Chart;
26  import org.kuali.kfs.coa.businessobject.ObjectType;
27  import org.kuali.kfs.coa.businessobject.SubAccount;
28  import org.kuali.rice.core.api.util.type.KualiInteger;
29  import org.kuali.rice.krad.bo.PersistableBusinessObjectBase;
30  
31  /**
32   * 
33   */
34  public class BudgetConstructionRequestMove extends PersistableBusinessObjectBase {
35  
36      private String principalId;
37      private String chartOfAccountsCode;
38      private String accountNumber;
39      private String subAccountNumber;
40      private String financialObjectCode;
41      private String financialSubObjectCode;
42      private String financialObjectTypeCode;
43      private KualiInteger accountLineAnnualBalanceAmount;
44      private String requestUpdateErrorCode;
45      private KualiInteger financialDocumentMonth1LineAmount;
46      private KualiInteger financialDocumentMonth2LineAmount;
47      private KualiInteger financialDocumentMonth3LineAmount;
48      private KualiInteger financialDocumentMonth4LineAmount;
49      private KualiInteger financialDocumentMonth5LineAmount;
50      private KualiInteger financialDocumentMonth6LineAmount;
51      private KualiInteger financialDocumentMonth7LineAmount;
52      private KualiInteger financialDocumentMonth8LineAmount;
53      private KualiInteger financialDocumentMonth9LineAmount;
54      private KualiInteger financialDocumentMonth10LineAmount;
55      private KualiInteger financialDocumentMonth11LineAmount;
56      private KualiInteger financialDocumentMonth12LineAmount;
57      
58      private boolean hasAccess = false;
59      private boolean hasLock = false;
60      
61      private Chart chartOfAccounts;
62      private Account account;
63      private SubAccount subAccount;
64      private ObjectType objectType;
65  
66      /**
67       * Default constructor.
68       */
69      public BudgetConstructionRequestMove() {
70  
71      }
72  
73      /**
74       * Gets the principalId attribute.
75       * 
76       * @return Returns the principalId
77       */
78      public String getPrincipalId() {
79          return principalId;
80      }
81  
82      /**
83       * Sets the principalId attribute.
84       * 
85       * @param principalId The principalId to set.
86       */
87      public void setPrincipalId(String principalId) {
88          this.principalId = principalId;
89      }
90  
91  
92      /**
93       * Gets the chartOfAccountsCode attribute.
94       * 
95       * @return Returns the chartOfAccountsCode
96       */
97      public String getChartOfAccountsCode() {
98          return chartOfAccountsCode;
99      }
100 
101     /**
102      * Sets the chartOfAccountsCode attribute.
103      * 
104      * @param chartOfAccountsCode The chartOfAccountsCode to set.
105      */
106     public void setChartOfAccountsCode(String chartOfAccountsCode) {
107         this.chartOfAccountsCode = chartOfAccountsCode;
108     }
109 
110 
111     /**
112      * Gets the accountNumber attribute.
113      * 
114      * @return Returns the accountNumber
115      */
116     public String getAccountNumber() {
117         return accountNumber;
118     }
119 
120     /**
121      * Sets the accountNumber attribute.
122      * 
123      * @param accountNumber The accountNumber to set.
124      */
125     public void setAccountNumber(String accountNumber) {
126         this.accountNumber = accountNumber;
127     }
128 
129 
130     /**
131      * Gets the subAccountNumber attribute.
132      * 
133      * @return Returns the subAccountNumber
134      */
135     public String getSubAccountNumber() {
136         return subAccountNumber;
137     }
138 
139     /**
140      * Sets the subAccountNumber attribute.
141      * 
142      * @param subAccountNumber The subAccountNumber to set.
143      */
144     public void setSubAccountNumber(String subAccountNumber) {
145         this.subAccountNumber = subAccountNumber;
146     }
147 
148 
149     /**
150      * Gets the financialObjectCode attribute.
151      * 
152      * @return Returns the financialObjectCode
153      */
154     public String getFinancialObjectCode() {
155         return financialObjectCode;
156     }
157 
158     /**
159      * Sets the financialObjectCode attribute.
160      * 
161      * @param financialObjectCode The financialObjectCode to set.
162      */
163     public void setFinancialObjectCode(String financialObjectCode) {
164         this.financialObjectCode = financialObjectCode;
165     }
166 
167 
168     /**
169      * Gets the financialSubObjectCode attribute.
170      * 
171      * @return Returns the financialSubObjectCode
172      */
173     public String getFinancialSubObjectCode() {
174         return financialSubObjectCode;
175     }
176 
177     /**
178      * Sets the financialSubObjectCode attribute.
179      * 
180      * @param financialSubObjectCode The financialSubObjectCode to set.
181      */
182     public void setFinancialSubObjectCode(String financialSubObjectCode) {
183         this.financialSubObjectCode = financialSubObjectCode;
184     }
185 
186 
187     /**
188      * Gets the financialObjectTypeCode attribute.
189      * 
190      * @return Returns the financialObjectTypeCode
191      */
192     public String getFinancialObjectTypeCode() {
193         return financialObjectTypeCode;
194     }
195 
196     /**
197      * Sets the financialObjectTypeCode attribute.
198      * 
199      * @param financialObjectTypeCode The financialObjectTypeCode to set.
200      */
201     public void setFinancialObjectTypeCode(String financialObjectTypeCode) {
202         this.financialObjectTypeCode = financialObjectTypeCode;
203     }
204 
205 
206     /**
207      * Gets the accountLineAnnualBalanceAmount attribute.
208      * 
209      * @return Returns the accountLineAnnualBalanceAmount.
210      */
211     public KualiInteger getAccountLineAnnualBalanceAmount() {
212         return accountLineAnnualBalanceAmount;
213     }
214 
215     /**
216      * Sets the accountLineAnnualBalanceAmount attribute value.
217      * 
218      * @param accountLineAnnualBalanceAmount The accountLineAnnualBalanceAmount to set.
219      */
220     public void setAccountLineAnnualBalanceAmount(KualiInteger accountLineAnnualBalanceAmount) {
221         this.accountLineAnnualBalanceAmount = accountLineAnnualBalanceAmount;
222     }
223 
224     /**
225      * Gets the requestUpdateErrorCode attribute.
226      * 
227      * @return Returns the requestUpdateErrorCode
228      */
229     public String getRequestUpdateErrorCode() {
230         return requestUpdateErrorCode;
231     }
232 
233     /**
234      * Sets the requestUpdateErrorCode attribute.
235      * 
236      * @param requestUpdateErrorCode The requestUpdateErrorCode to set.
237      */
238     public void setRequestUpdateErrorCode(String requestUpdateErrorCode) {
239         this.requestUpdateErrorCode = requestUpdateErrorCode;
240     }
241 
242 
243     /**
244      * Gets the financialDocumentMonth10LineAmount attribute.
245      * 
246      * @return Returns the financialDocumentMonth10LineAmount.
247      */
248     public KualiInteger getFinancialDocumentMonth10LineAmount() {
249         return financialDocumentMonth10LineAmount;
250     }
251 
252     /**
253      * Sets the financialDocumentMonth10LineAmount attribute value.
254      * 
255      * @param financialDocumentMonth10LineAmount The financialDocumentMonth10LineAmount to set.
256      */
257     public void setFinancialDocumentMonth10LineAmount(KualiInteger financialDocumentMonth10LineAmount) {
258         this.financialDocumentMonth10LineAmount = financialDocumentMonth10LineAmount;
259     }
260 
261     /**
262      * Gets the financialDocumentMonth11LineAmount attribute.
263      * 
264      * @return Returns the financialDocumentMonth11LineAmount.
265      */
266     public KualiInteger getFinancialDocumentMonth11LineAmount() {
267         return financialDocumentMonth11LineAmount;
268     }
269 
270     /**
271      * Sets the financialDocumentMonth11LineAmount attribute value.
272      * 
273      * @param financialDocumentMonth11LineAmount The financialDocumentMonth11LineAmount to set.
274      */
275     public void setFinancialDocumentMonth11LineAmount(KualiInteger financialDocumentMonth11LineAmount) {
276         this.financialDocumentMonth11LineAmount = financialDocumentMonth11LineAmount;
277     }
278 
279     /**
280      * Gets the financialDocumentMonth12LineAmount attribute.
281      * 
282      * @return Returns the financialDocumentMonth12LineAmount.
283      */
284     public KualiInteger getFinancialDocumentMonth12LineAmount() {
285         return financialDocumentMonth12LineAmount;
286     }
287 
288     /**
289      * Sets the financialDocumentMonth12LineAmount attribute value.
290      * 
291      * @param financialDocumentMonth12LineAmount The financialDocumentMonth12LineAmount to set.
292      */
293     public void setFinancialDocumentMonth12LineAmount(KualiInteger financialDocumentMonth12LineAmount) {
294         this.financialDocumentMonth12LineAmount = financialDocumentMonth12LineAmount;
295     }
296 
297     /**
298      * Gets the financialDocumentMonth1LineAmount attribute.
299      * 
300      * @return Returns the financialDocumentMonth1LineAmount.
301      */
302     public KualiInteger getFinancialDocumentMonth1LineAmount() {
303         return financialDocumentMonth1LineAmount;
304     }
305 
306     /**
307      * Sets the financialDocumentMonth1LineAmount attribute value.
308      * 
309      * @param financialDocumentMonth1LineAmount The financialDocumentMonth1LineAmount to set.
310      */
311     public void setFinancialDocumentMonth1LineAmount(KualiInteger financialDocumentMonth1LineAmount) {
312         this.financialDocumentMonth1LineAmount = financialDocumentMonth1LineAmount;
313     }
314 
315     /**
316      * Gets the financialDocumentMonth2LineAmount attribute.
317      * 
318      * @return Returns the financialDocumentMonth2LineAmount.
319      */
320     public KualiInteger getFinancialDocumentMonth2LineAmount() {
321         return financialDocumentMonth2LineAmount;
322     }
323 
324     /**
325      * Sets the financialDocumentMonth2LineAmount attribute value.
326      * 
327      * @param financialDocumentMonth2LineAmount The financialDocumentMonth2LineAmount to set.
328      */
329     public void setFinancialDocumentMonth2LineAmount(KualiInteger financialDocumentMonth2LineAmount) {
330         this.financialDocumentMonth2LineAmount = financialDocumentMonth2LineAmount;
331     }
332 
333     /**
334      * Gets the financialDocumentMonth3LineAmount attribute.
335      * 
336      * @return Returns the financialDocumentMonth3LineAmount.
337      */
338     public KualiInteger getFinancialDocumentMonth3LineAmount() {
339         return financialDocumentMonth3LineAmount;
340     }
341 
342     /**
343      * Sets the financialDocumentMonth3LineAmount attribute value.
344      * 
345      * @param financialDocumentMonth3LineAmount The financialDocumentMonth3LineAmount to set.
346      */
347     public void setFinancialDocumentMonth3LineAmount(KualiInteger financialDocumentMonth3LineAmount) {
348         this.financialDocumentMonth3LineAmount = financialDocumentMonth3LineAmount;
349     }
350 
351     /**
352      * Gets the financialDocumentMonth4LineAmount attribute.
353      * 
354      * @return Returns the financialDocumentMonth4LineAmount.
355      */
356     public KualiInteger getFinancialDocumentMonth4LineAmount() {
357         return financialDocumentMonth4LineAmount;
358     }
359 
360     /**
361      * Sets the financialDocumentMonth4LineAmount attribute value.
362      * 
363      * @param financialDocumentMonth4LineAmount The financialDocumentMonth4LineAmount to set.
364      */
365     public void setFinancialDocumentMonth4LineAmount(KualiInteger financialDocumentMonth4LineAmount) {
366         this.financialDocumentMonth4LineAmount = financialDocumentMonth4LineAmount;
367     }
368 
369     /**
370      * Gets the financialDocumentMonth5LineAmount attribute.
371      * 
372      * @return Returns the financialDocumentMonth5LineAmount.
373      */
374     public KualiInteger getFinancialDocumentMonth5LineAmount() {
375         return financialDocumentMonth5LineAmount;
376     }
377 
378     /**
379      * Sets the financialDocumentMonth5LineAmount attribute value.
380      * 
381      * @param financialDocumentMonth5LineAmount The financialDocumentMonth5LineAmount to set.
382      */
383     public void setFinancialDocumentMonth5LineAmount(KualiInteger financialDocumentMonth5LineAmount) {
384         this.financialDocumentMonth5LineAmount = financialDocumentMonth5LineAmount;
385     }
386 
387     /**
388      * Gets the financialDocumentMonth6LineAmount attribute.
389      * 
390      * @return Returns the financialDocumentMonth6LineAmount.
391      */
392     public KualiInteger getFinancialDocumentMonth6LineAmount() {
393         return financialDocumentMonth6LineAmount;
394     }
395 
396     /**
397      * Sets the financialDocumentMonth6LineAmount attribute value.
398      * 
399      * @param financialDocumentMonth6LineAmount The financialDocumentMonth6LineAmount to set.
400      */
401     public void setFinancialDocumentMonth6LineAmount(KualiInteger financialDocumentMonth6LineAmount) {
402         this.financialDocumentMonth6LineAmount = financialDocumentMonth6LineAmount;
403     }
404 
405     /**
406      * Gets the financialDocumentMonth7LineAmount attribute.
407      * 
408      * @return Returns the financialDocumentMonth7LineAmount.
409      */
410     public KualiInteger getFinancialDocumentMonth7LineAmount() {
411         return financialDocumentMonth7LineAmount;
412     }
413 
414     /**
415      * Sets the financialDocumentMonth7LineAmount attribute value.
416      * 
417      * @param financialDocumentMonth7LineAmount The financialDocumentMonth7LineAmount to set.
418      */
419     public void setFinancialDocumentMonth7LineAmount(KualiInteger financialDocumentMonth7LineAmount) {
420         this.financialDocumentMonth7LineAmount = financialDocumentMonth7LineAmount;
421     }
422 
423     /**
424      * Gets the financialDocumentMonth8LineAmount attribute.
425      * 
426      * @return Returns the financialDocumentMonth8LineAmount.
427      */
428     public KualiInteger getFinancialDocumentMonth8LineAmount() {
429         return financialDocumentMonth8LineAmount;
430     }
431 
432     /**
433      * Sets the financialDocumentMonth8LineAmount attribute value.
434      * 
435      * @param financialDocumentMonth8LineAmount The financialDocumentMonth8LineAmount to set.
436      */
437     public void setFinancialDocumentMonth8LineAmount(KualiInteger financialDocumentMonth8LineAmount) {
438         this.financialDocumentMonth8LineAmount = financialDocumentMonth8LineAmount;
439     }
440 
441     /**
442      * Gets the financialDocumentMonth9LineAmount attribute.
443      * 
444      * @return Returns the financialDocumentMonth9LineAmount.
445      */
446     public KualiInteger getFinancialDocumentMonth9LineAmount() {
447         return financialDocumentMonth9LineAmount;
448     }
449 
450     /**
451      * Sets the financialDocumentMonth9LineAmount attribute value.
452      * 
453      * @param financialDocumentMonth9LineAmount The financialDocumentMonth9LineAmount to set.
454      */
455     public void setFinancialDocumentMonth9LineAmount(KualiInteger financialDocumentMonth9LineAmount) {
456         this.financialDocumentMonth9LineAmount = financialDocumentMonth9LineAmount;
457     }
458 
459     /**
460      * Gets the chartOfAccounts attribute.
461      * 
462      * @return Returns the chartOfAccounts
463      */
464     public Chart getChartOfAccounts() {
465         return chartOfAccounts;
466     }
467     
468     /**
469      * returs true if user has access
470      * 
471      * @return
472      */
473     public boolean getHasAccess() {
474         return this.hasAccess;
475     }
476 
477     /**
478      * sets user access
479      * 
480      * @param hasAccess
481      */
482     public void setHasAccess(boolean hasAccess) {
483         this.hasAccess = hasAccess;
484     }
485     
486     /**
487      * returns true if record has lock
488      * 
489      * @return
490      */
491     public boolean getHasLock() {
492         return this.hasLock;
493     }
494     
495     /**
496      * sets has lock
497      * 
498      * @param hasLock
499      */
500     public void setHasLock(boolean hasLock) {
501         this.hasLock = hasLock;
502     }
503     
504     /**
505      * returns concatenated string of principalId, chart, account, subaccount
506      * 
507      * @return
508      */
509     public String getSubAccountingString() {
510         return principalId + "-" + chartOfAccountsCode + "-" + accountNumber + "-" + subAccountNumber;
511     }
512     
513     public String getErrorLinePrefixForLogFile() {
514         return "Line Key: " + chartOfAccountsCode + ", " + accountNumber + ", " + subAccountNumber + ", " + financialObjectCode + ", " + financialSubObjectCode;
515     }
516     
517     /**
518      * Sets the chartOfAccounts attribute.
519      * 
520      * @param chartOfAccounts The chartOfAccounts to set.
521      * @deprecated
522      */
523     public void setChartOfAccounts(Chart chartOfAccounts) {
524         this.chartOfAccounts = chartOfAccounts;
525     }
526 
527     /**
528      * Gets the account attribute.
529      * 
530      * @return Returns the account
531      */
532     public Account getAccount() {
533         return account;
534     }
535 
536     /**
537      * Sets the account attribute.
538      * 
539      * @param account The account to set.
540      * @deprecated
541      */
542     public void setAccount(Account account) {
543         this.account = account;
544     }
545 
546     /**
547      * Gets the objectType attribute.
548      * 
549      * @return Returns the objectType.
550      */
551     public ObjectType getObjectType() {
552         return objectType;
553     }
554 
555     /**
556      * Sets the objectType attribute value.
557      * 
558      * @param objectType The objectType to set.
559      * @deprecated
560      */
561     public void setObjectType(ObjectType objectType) {
562         this.objectType = objectType;
563     }
564 
565     /**
566      * Gets the subAccount attribute.
567      * 
568      * @return Returns the subAccount.
569      */
570     public SubAccount getSubAccount() {
571         return subAccount;
572     }
573 
574     /**
575      * Sets the subAccount attribute value.
576      * 
577      * @param subAccount The subAccount to set.
578      * @deprecated
579      */
580     public void setSubAccount(SubAccount subAccount) {
581         this.subAccount = subAccount;
582     }
583 
584     /**
585      * @see org.kuali.rice.krad.bo.BusinessObjectBase#toStringMapper()
586      */
587     protected LinkedHashMap toStringMapper_RICE20_REFACTORME() {
588         LinkedHashMap m = new LinkedHashMap();
589         m.put("principalId", this.principalId);
590         m.put("chartOfAccountsCode", this.chartOfAccountsCode);
591         m.put("accountNumber", this.accountNumber);
592         m.put("subAccountNumber", this.subAccountNumber);
593         m.put("financialObjectCode", this.financialObjectCode);
594         m.put("financialSubObjectCode", this.financialSubObjectCode);
595         return m;
596     }
597 
598 }
599