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