@AccessLevel(value=EXTERNAL)
public interface Obligation
extends curam.obligation.impl.ObligationAccessor, curam.util.persistence.Insertable, curam.util.type.DateRanged, curam.util.persistence.OptimisticLockModifiable
Modifier and Type | Interface and Description |
---|---|
static interface |
Obligation.ObligationCreateObligationEvents
Interface to the obligation events functionality surrounding the
createObligation method.
|
static interface |
Obligation.ObligationProcessObligationEvents
Interface to the obligation events functionality surrounding the
processObligation method.
|
static interface |
Obligation.ObligationUpdateObligationEvents
Interface to the obligation events functionality surrounding the
updateObligation method.
|
Modifier and Type | Method and Description |
---|---|
curam.obligation.impl.ObligationResult |
createObligation(java.lang.Long programFundID,
curam.util.type.Money requestedAmount,
curam.util.type.DateRange obligationPeriod,
java.lang.Long obligationRelatedID,
curam.codetable.impl.OBLIGATIONRELATEDTYPEEntry obligationRelatedType,
java.lang.Long caseParticipantRoleID,
java.lang.Integer waitListExpiryDays)
Creates an obligation for a fund.
|
FundFiscalYear |
getFundFiscalYear()
Gets the immutable fund fiscal year for the obligation.
|
curam.obligation.impl.ObligationResult |
processObligation(java.lang.Long fundRelatedID,
curam.codetable.impl.FUNDRELATIONTYPEEntry fundRelationType,
curam.util.type.Money requestedAmount,
curam.util.type.DateRange obligationPeriod,
java.lang.Long obligationRelatedID,
curam.codetable.impl.OBLIGATIONRELATEDTYPEEntry obligationRelatedType,
java.lang.Long caseParticipantRoleID,
java.lang.Integer waitListExpiryDays)
Processes the obligation for a financial transaction.
|
void |
setAmount(curam.util.type.Money amount)
Sets the financial amount associated with the obligation.
|
void |
setCreditDebitType(curam.codetable.impl.CREDITDEBITEntry creditDebitType)
Sets the indicator if the obligation increases or decreases the fund fiscal
year Remaining Budgeted Balance, and the Obligated Total.
|
void |
setDateRange(curam.util.type.DateRange dateRange)
Sets the obligation period.
|
void |
setFundFiscalYearID(java.lang.Long fundFiscalYearID)
Sets the fund fiscal year ID for the obligation.
|
void |
setRelatedID(java.lang.Long relatedID)
Sets the unique reference number of the related financial transaction which
caused the obligation to be created, such as a Product Delivery or Planned
Item.
|
void |
setRelatedType(curam.codetable.impl.OBLIGATIONRELATEDTYPEEntry relatedType)
Sets the type of financial transaction which caused the obligation to be
created, such as a Product Delivery or Planned Item
|
void |
setTransactionType(curam.codetable.impl.OBLIGATIONTRANSACTIONTYPEEntry transactionType)
Sets the type of transaction, such as Obligation or Obligation adjustment.
|
curam.obligation.impl.ObligationResult |
updateObligation(curam.util.type.Money requestedAmount,
curam.util.type.DateRange obligationPeriod,
java.lang.Long obligationRelatedID,
curam.codetable.impl.OBLIGATIONRELATEDTYPEEntry obligationRelatedType)
Modifies an obligation for a fund fiscal year for the given related ID and
related type.
|
getAmount, getCreationDate, getCreditDebitType, getRelatedID, getRelatedType, getTransactionType
@AccessLevel(value=EXTERNAL) curam.obligation.impl.ObligationResult createObligation(java.lang.Long programFundID, curam.util.type.Money requestedAmount, curam.util.type.DateRange obligationPeriod, java.lang.Long obligationRelatedID, curam.codetable.impl.OBLIGATIONRELATEDTYPEEntry obligationRelatedType, java.lang.Long caseParticipantRoleID, java.lang.Integer waitListExpiryDays) throws curam.util.exception.AppException, curam.util.exception.InformationalException
programFundID
- The key of the program fund.requestedAmount
- The amount requested to obligate a fund.obligationPeriod
- The period for which the fund needs to be obligated.obligationRelatedID
- The key of the related financial transaction which causes the
obligation, such as a Product Delivery or Planned Item.obligationRelatedType
- The type of the related financial transaction which causes the
obligation, such as a Product Delivery or Planned Item. * @param
caseParticipantRoleID The case participant role ID of the client.caseParticipantRoleID
- The case participant role key of the client.waitListExpiryDays
- The expiry days of the wait list.curam.util.exception.AppException
curam.util.exception.InformationalException
The
default implementation -
curam.obligation.impl.ObligationImpl#createObligation(Long, Money,
DateRange, Long, OBLIGATIONRELATEDTYPEEntry, Long, Integer).
Fund |
Obligation, WaitList, FundFiscalYear |
FundFiscalYear getFundFiscalYear()
getFundFiscalYear
in interface curam.obligation.impl.ObligationAccessor
@AccessLevel(value=EXTERNAL) curam.obligation.impl.ObligationResult processObligation(java.lang.Long fundRelatedID, curam.codetable.impl.FUNDRELATIONTYPEEntry fundRelationType, curam.util.type.Money requestedAmount, curam.util.type.DateRange obligationPeriod, java.lang.Long obligationRelatedID, curam.codetable.impl.OBLIGATIONRELATEDTYPEEntry obligationRelatedType, java.lang.Long caseParticipantRoleID, java.lang.Integer waitListExpiryDays) throws curam.util.exception.AppException, curam.util.exception.InformationalException
fundRelatedID
- The key of the funded item which causes the obligation. For e.g.,
ProductID or ServiceOfferingID.fundRelationType
- The type of the funded item which causes the obligation. For e.g.,
Product or Service Offering.requestedAmount
- The amount requested to obligate a fund.obligationPeriod
- The period for which a fund needs to be obligated.obligationRelatedID
- The key of the related financial transaction which causes the
obligation, such as a Product Delivery or Planned Item.obligationRelatedType
- The type of financial transaction which causes the obligation,
such as a Product Delivery or Planned Item.caseParticipantRoleID
- The case participant role key of the client.waitListExpiryDays
- The expiry days of the wait list.curam.util.exception.AppException
curam.util.exception.InformationalException
The default implementation
- curam.obligation.impl.ObligationImpl#processObligation(Long,
FUNDRELATIONTYPEEntry, Money, DateRange, Long,
OBLIGATIONRELATEDTYPEEntry, Long, Integer).
Obligation, Fund |
Obligation, WaitList, FundFiscalYear |
void setAmount(curam.util.type.Money amount)
amount
- The financial amount associated with the obligation.void setRelatedID(java.lang.Long relatedID)
relatedID
- The unique reference number of the related financial transaction
which caused the obligation to be created, such as a Product
Delivery or Planned Item.void setTransactionType(curam.codetable.impl.OBLIGATIONTRANSACTIONTYPEEntry transactionType)
transactionType
- The type of transaction, such as Obligation or Obligation
adjustment.void setCreditDebitType(curam.codetable.impl.CREDITDEBITEntry creditDebitType)
creditDebitType
- The indicator if the obligation increases or decreases the fund
fiscal year Remaining Budgeted Balance, and the Obligated Total.void setDateRange(curam.util.type.DateRange dateRange)
dateRange
- The obligation period.void setFundFiscalYearID(java.lang.Long fundFiscalYearID)
fundFiscalYearID
- The fund fiscal year ID.void setRelatedType(curam.codetable.impl.OBLIGATIONRELATEDTYPEEntry relatedType)
relatedType
- The type of financial transaction which caused the obligation to
be created, such as a Product Delivery or Planned Item@AccessLevel(value=EXTERNAL) curam.obligation.impl.ObligationResult updateObligation(curam.util.type.Money requestedAmount, curam.util.type.DateRange obligationPeriod, java.lang.Long obligationRelatedID, curam.codetable.impl.OBLIGATIONRELATEDTYPEEntry obligationRelatedType) throws curam.util.exception.AppException, curam.util.exception.InformationalException
requestedAmount
- The amount requested to obligate a fund.obligationPeriod
- The period for which a fund needs to be obligated.obligationRelatedID
- The key of the related financial transaction which causes the
obligation, such as a Product Delivery or Planned Item.obligationRelatedType
- The type of financial transaction which causes the obligation,
such as a Product Delivery or Planned Item.curam.util.exception.AppException
curam.util.exception.InformationalException
The default
implementation -
curam.obligation.impl.ObligationImpl#updateObligation(Money,
DateRange, Long, OBLIGATIONRELATEDTYPEEntry).
Obligation |
Obligation, FundFiscalYear |