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.integration.ld;
20
21 import java.sql.Date;
22 import java.sql.Timestamp;
23
24 import org.kuali.kfs.coa.businessobject.Account;
25 import org.kuali.kfs.coa.businessobject.BalanceType;
26 import org.kuali.kfs.coa.businessobject.Chart;
27 import org.kuali.kfs.coa.businessobject.ObjectCode;
28 import org.kuali.kfs.coa.businessobject.ObjectType;
29 import org.kuali.kfs.coa.businessobject.SubAccount;
30 import org.kuali.kfs.coa.businessobject.SubObjectCode;
31 import org.kuali.kfs.sys.businessobject.SystemOptions;
32 import org.kuali.rice.core.api.util.type.KualiDecimal;
33 import org.kuali.rice.kim.api.identity.Person;
34 import org.kuali.rice.krad.bo.PersistableBusinessObject;
35
36 public interface LaborLedgerBalance extends PersistableBusinessObject{
37
38 /**
39 * Gets the account attribute.
40 *
41 * @return Returns the account.
42 */
43 public Account getAccount();
44
45 /**
46 * Sets the account attribute value.
47 *
48 * @param account The account to set.
49 */
50 public void setAccount(Account account);
51
52 /**
53 * Gets the accountLineAnnualBalanceAmount attribute.
54 *
55 * @return Returns the accountLineAnnualBalanceAmount.
56 */
57 public KualiDecimal getAccountLineAnnualBalanceAmount();
58
59 /**
60 * Sets the accountLineAnnualBalanceAmount attribute value.
61 *
62 * @param accountLineAnnualBalanceAmount The accountLineAnnualBalanceAmount to set.
63 */
64 public void setAccountLineAnnualBalanceAmount(KualiDecimal accountLineAnnualBalanceAmount);
65
66 /**
67 * Gets the accountNumber attribute.
68 *
69 * @return Returns the accountNumber.
70 */
71 public String getAccountNumber();
72
73 /**
74 * Sets the accountNumber attribute value.
75 *
76 * @param accountNumber The accountNumber to set.
77 */
78 public void setAccountNumber(String accountNumber);
79
80 /**
81 * Gets the balanceType attribute.
82 *
83 * @return Returns the balanceType.
84 */
85 public BalanceType getBalanceType();
86
87 /**
88 * Sets the balanceType attribute value.
89 *
90 * @param balanceType The balanceType to set.
91 */
92 public void setBalanceType(BalanceType balanceType);
93
94 /**
95 * Gets the beginningBalanceLineAmount attribute.
96 *
97 * @return Returns the beginningBalanceLineAmount.
98 */
99 public KualiDecimal getBeginningBalanceLineAmount();
100
101 /**
102 * Sets the beginningBalanceLineAmount attribute value.
103 *
104 * @param beginningBalanceLineAmount The beginningBalanceLineAmount to set.
105 */
106 public void setBeginningBalanceLineAmount(KualiDecimal beginningBalanceLineAmount);
107
108 /**
109 * Gets the chartOfAccounts attribute.
110 *
111 * @return Returns the chartOfAccounts.
112 */
113 public Chart getChartOfAccounts();
114
115 /**
116 * Sets the chartOfAccounts attribute value.
117 *
118 * @param chartOfAccounts The chartOfAccounts to set.
119 */
120 public void setChartOfAccounts(Chart chartOfAccounts);
121
122 /**
123 * Gets the chartOfAccountsCode attribute.
124 *
125 * @return Returns the chartOfAccountsCode.
126 */
127 public String getChartOfAccountsCode();
128
129 /**
130 * Sets the chartOfAccountsCode attribute value.
131 *
132 * @param chartOfAccountsCode The chartOfAccountsCode to set.
133 */
134 public void setChartOfAccountsCode(String chartOfAccountsCode);
135
136 /**
137 * Gets the contractsGrantsBeginningBalanceAmount attribute.
138 *
139 * @return Returns the contractsGrantsBeginningBalanceAmount.
140 */
141 public KualiDecimal getContractsGrantsBeginningBalanceAmount();
142
143 /**
144 * Sets the contractsGrantsBeginningBalanceAmount attribute value.
145 *
146 * @param contractsGrantsBeginningBalanceAmount The contractsGrantsBeginningBalanceAmount to set.
147 */
148 public void setContractsGrantsBeginningBalanceAmount(KualiDecimal contractsGrantsBeginningBalanceAmount);
149
150 /**
151 * Gets the emplid attribute.
152 *
153 * @return Returns the emplid.
154 */
155 public String getEmplid();
156
157 /**
158 * Sets the emplid attribute value.
159 *
160 * @param emplid The emplid to set.
161 */
162 public void setEmplid(String emplid);
163
164 /**
165 * Gets the financialBalanceTypeCode attribute.
166 *
167 * @return Returns the financialBalanceTypeCode.
168 */
169 public String getFinancialBalanceTypeCode();
170
171 /**
172 * Sets the financialBalanceTypeCode attribute value.
173 *
174 * @param financialBalanceTypeCode The financialBalanceTypeCode to set.
175 */
176 public void setFinancialBalanceTypeCode(String financialBalanceTypeCode);
177
178 /**
179 * Gets the financialBeginningBalanceLineAmount attribute.
180 *
181 * @return Returns the financialBeginningBalanceLineAmount.
182 */
183 public KualiDecimal getFinancialBeginningBalanceLineAmount();
184
185 /**
186 * Sets the financialBeginningBalanceLineAmount attribute value.
187 *
188 * @param financialBeginningBalanceLineAmount The financialBeginningBalanceLineAmount to set.
189 */
190 public void setFinancialBeginningBalanceLineAmount(KualiDecimal financialBeginningBalanceLineAmount);
191
192 /**
193 * Gets the financialObject attribute.
194 *
195 * @return Returns the financialObject.
196 */
197 public ObjectCode getFinancialObject();
198
199 /**
200 * Sets the financialObject attribute value.
201 *
202 * @param financialObject The financialObject to set.
203 */
204 public void setFinancialObject(ObjectCode financialObject);
205
206 /**
207 * Gets the financialObjectCode attribute.
208 *
209 * @return Returns the financialObjectCode.
210 */
211 public String getFinancialObjectCode();
212
213 /**
214 * Sets the financialObjectCode attribute value.
215 *
216 * @param financialObjectCode The financialObjectCode to set.
217 */
218 public void setFinancialObjectCode(String financialObjectCode);
219
220 /**
221 * Gets the financialObjectType attribute.
222 *
223 * @return Returns the financialObjectType.
224 */
225 public ObjectType getFinancialObjectType();
226
227 /**
228 * Sets the financialObjectType attribute value.
229 *
230 * @param financialObjectType The financialObjectType to set.
231 */
232 public void setFinancialObjectType(ObjectType financialObjectType);
233
234 /**
235 * Gets the financialObjectTypeCode attribute.
236 *
237 * @return Returns the financialObjectTypeCode.
238 */
239 public String getFinancialObjectTypeCode();
240
241 /**
242 * Sets the financialObjectTypeCode attribute value.
243 *
244 * @param financialObjectTypeCode The financialObjectTypeCode to set.
245 */
246 public void setFinancialObjectTypeCode(String financialObjectTypeCode);
247
248 /**
249 * Gets the financialSubObject attribute.
250 *
251 * @return Returns the financialSubObject.
252 */
253 public SubObjectCode getFinancialSubObject();
254
255 /**
256 * Sets the financialSubObject attribute value.
257 *
258 * @param financialSubObject The financialSubObject to set.
259 */
260 public void setFinancialSubObject(SubObjectCode financialSubObject);
261
262 /**
263 * Gets the financialSubObjectCode attribute.
264 *
265 * @return Returns the financialSubObjectCode.
266 */
267 public String getFinancialSubObjectCode();
268
269 /**
270 * Sets the financialSubObjectCode attribute value.
271 *
272 * @param financialSubObjectCode The financialSubObjectCode to set.
273 */
274 public void setFinancialSubObjectCode(String financialSubObjectCode);
275
276 /**
277 * Gets the laborLedgerObject attribute.
278 *
279 * @return Returns the laborLedgerObject.
280 */
281 public LaborLedgerObject getLaborLedgerObject();
282
283 /**
284 * Sets the laborLedgerObject attribute value.
285 *
286 * @param laborObject The laborLedgerObject to set.
287 */
288 public void setLaborLedgerObject(LaborLedgerObject laborLedgerObject);
289
290 /**
291 * Gets the ledgerPerson attribute.
292 *
293 * @return Returns the ledgerPerson.
294 */
295 public Person getLedgerPerson();
296
297 /**
298 * Sets the ledgerPerson attribute value.
299 *
300 * @param ledgerPerson The ledgerPerson to set.
301 */
302 public void setLedgerPerson(Person ledgerPerson);
303
304 /**
305 * Gets the month10Amount attribute.
306 *
307 * @return Returns the month10Amount.
308 */
309 public KualiDecimal getMonth10Amount();
310
311 /**
312 * Sets the month10Amount attribute value.
313 *
314 * @param month10Amount The month10Amount to set.
315 */
316 public void setMonth10Amount(KualiDecimal month10Amount);
317
318 /**
319 * Gets the month11Amount attribute.
320 *
321 * @return Returns the month11Amount.
322 */
323 public KualiDecimal getMonth11Amount();
324
325 /**
326 * Sets the month11Amount attribute value.
327 *
328 * @param month11Amount The month11Amount to set.
329 */
330 public void setMonth11Amount(KualiDecimal month11Amount);
331
332 /**
333 * Gets the month12Amount attribute.
334 *
335 * @return Returns the month12Amount.
336 */
337 public KualiDecimal getMonth12Amount();
338
339 /**
340 * Sets the month12Amount attribute value.
341 *
342 * @param month12Amount The month12Amount to set.
343 */
344 public void setMonth12Amount(KualiDecimal month12Amount);
345
346 /**
347 * Gets the month13Amount attribute.
348 *
349 * @return Returns the month13Amount.
350 */
351 public KualiDecimal getMonth13Amount();
352
353 /**
354 * Sets the month13Amount attribute value.
355 *
356 * @param month13Amount The month13Amount to set.
357 */
358 public void setMonth13Amount(KualiDecimal month13Amount);
359
360 /**
361 * Gets the month1Amount attribute.
362 *
363 * @return Returns the month1Amount.
364 */
365 public KualiDecimal getMonth1Amount();
366
367 /**
368 * Sets the month1Amount attribute value.
369 *
370 * @param month1Amount The month1Amount to set.
371 */
372 public void setMonth1Amount(KualiDecimal month1Amount);
373
374 /**
375 * Gets the month2Amount attribute.
376 *
377 * @return Returns the month2Amount.
378 */
379 public KualiDecimal getMonth2Amount();
380
381 /**
382 * Sets the month2Amount attribute value.
383 *
384 * @param month2Amount The month2Amount to set.
385 */
386 public void setMonth2Amount(KualiDecimal month2Amount);
387
388 /**
389 * Gets the month3Amount attribute.
390 *
391 * @return Returns the month3Amount.
392 */
393 public KualiDecimal getMonth3Amount();
394
395 /**
396 * Sets the month3Amount attribute value.
397 *
398 * @param month3Amount The month3Amount to set.
399 */
400 public void setMonth3Amount(KualiDecimal month3Amount);
401
402 /**
403 * Gets the month4Amount attribute.
404 *
405 * @return Returns the month4Amount.
406 */
407 public KualiDecimal getMonth4Amount();
408
409 /**
410 * Sets the month4Amount attribute value.
411 *
412 * @param month4Amount The month4Amount to set.
413 */
414 public void setMonth4Amount(KualiDecimal month4Amount);
415
416 /**
417 * Gets the month5Amount attribute.
418 *
419 * @return Returns the month5Amount.
420 */
421 public KualiDecimal getMonth5Amount();
422
423 /**
424 * Sets the month5Amount attribute value.
425 *
426 * @param month5Amount The month5Amount to set.
427 */
428 public void setMonth5Amount(KualiDecimal month5Amount);
429
430 /**
431 * Gets the month6Amount attribute.
432 *
433 * @return Returns the month6Amount.
434 */
435 public KualiDecimal getMonth6Amount();
436
437 /**
438 * Sets the month6Amount attribute value.
439 *
440 * @param month6Amount The month6Amount to set.
441 */
442 public void setMonth6Amount(KualiDecimal month6Amount);
443
444 /**
445 * Gets the month7Amount attribute.
446 *
447 * @return Returns the month7Amount.
448 */
449 public KualiDecimal getMonth7Amount();
450
451 /**
452 * Sets the month7Amount attribute value.
453 *
454 * @param month7Amount The month7Amount to set.
455 */
456 public void setMonth7Amount(KualiDecimal month7Amount);
457
458 /**
459 * Gets the month8Amount attribute.
460 *
461 * @return Returns the month8Amount.
462 */
463 public KualiDecimal getMonth8Amount();
464
465 /**
466 * Sets the month8Amount attribute value.
467 *
468 * @param month8Amount The month8Amount to set.
469 */
470 public void setMonth8Amount(KualiDecimal month8Amount);
471
472 /**
473 * Gets the month9Amount attribute.
474 *
475 * @return Returns the month9Amount.
476 */
477 public KualiDecimal getMonth9Amount();
478
479 /**
480 * Sets the month9Amount attribute value.
481 *
482 * @param month9Amount The month9Amount to set.
483 */
484 public void setMonth9Amount(KualiDecimal month9Amount);
485
486 /**
487 * Gets the objectType attribute.
488 *
489 * @return Returns the objectType.
490 */
491 public ObjectType getObjectType();
492
493 /**
494 * Sets the objectType attribute value.
495 *
496 * @param objectType The objectType to set.
497 */
498 public void setObjectType(ObjectType objectType);
499
500 /**
501 * Gets the option attribute.
502 *
503 * @return Returns the option.
504 */
505 public SystemOptions getOption();
506
507 /**
508 * Sets the option attribute value.
509 *
510 * @param option The option to set.
511 */
512 public void setOption(SystemOptions option);
513
514 /**
515 * Gets the positionNumber attribute.
516 *
517 * @return Returns the positionNumber.
518 */
519 public String getPositionNumber();
520
521 /**
522 * Sets the positionNumber attribute value.
523 *
524 * @param positionNumber The positionNumber to set.
525 */
526 public void setPositionNumber(String positionNumber);
527
528 /**
529 * Gets the subAccount attribute.
530 *
531 * @return Returns the subAccount.
532 */
533 public SubAccount getSubAccount();
534
535 /**
536 * Sets the subAccount attribute value.
537 *
538 * @param subAccount The subAccount to set.
539 */
540 public void setSubAccount(SubAccount subAccount);
541
542 /**
543 * Gets the subAccountNumber attribute.
544 *
545 * @return Returns the subAccountNumber.
546 */
547 public String getSubAccountNumber();
548
549 /**
550 * Sets the subAccountNumber attribute value.
551 *
552 * @param subAccountNumber The subAccountNumber to set.
553 */
554 public void setSubAccountNumber(String subAccountNumber);
555
556 /**
557 * Gets the timestamp attribute.
558 *
559 * @return Returns the timestamp.
560 */
561 public Date getTimestamp();
562
563 /**
564 * Sets the timestamp attribute value.
565 *
566 * @param timestamp The timestamp to set.
567 */
568 public void setTimestamp(Date timestamp);
569
570 /**
571 * Gets the transactionDateTimeStamp attribute.
572 *
573 * @return Returns the transactionDateTimeStamp.
574 */
575 public Timestamp getTransactionDateTimeStamp();
576
577 /**
578 * Sets the transactionDateTimeStamp attribute value.
579 *
580 * @param transactionDateTimeStamp The transactionDateTimeStamp to set.
581 */
582 public void setTransactionDateTimeStamp(Timestamp transactionDateTimeStamp);
583
584 /**
585 * Gets the universityFiscalYear attribute.
586 *
587 * @return Returns the universityFiscalYear.
588 */
589 public Integer getUniversityFiscalYear();
590
591 /**
592 * Sets the universityFiscalYear attribute value.
593 *
594 * @param universityFiscalYear The universityFiscalYear to set.
595 */
596 public void setUniversityFiscalYear(Integer universityFiscalYear);
597
598 /**
599 * get the amount in the given period.
600 *
601 * @param periodCode the given period code
602 */
603 public KualiDecimal getAmountByPeriod(String periodCode);
604
605 /**
606 * Adds amounts in a period.
607 *
608 * @param period, amount
609 */
610 public void addAmount(String period, KualiDecimal amount);
611 }
612