@AccessLevel(value=EXTERNAL)
public interface FundFiscalYear
extends curam.fundpm.impl.FundFiscalYearAccessor, curam.util.persistence.Insertable, curam.util.persistence.OptimisticLockModifiable, curam.util.persistence.helper.LogicallyDeleteable, curam.util.persistence.helper.Commented
Modifier and Type | Interface and Description |
---|---|
static interface |
FundFiscalYear.FundFiscalYearObligateAmountEvents
Interface to the fund fiscal year events functionality surrounding the
obligateAmount method.
|
Modifier and Type | Method and Description |
---|---|
boolean |
canObligate(curam.util.type.Money amount)
Returns true if this fiscal year has the amount requested.
|
curam.fundpm.impl.FiscalYear |
getFiscalYear()
Gets the fiscal year identifier of the fund fiscal year.
|
curam.fundpm.impl.ProgramFund |
getFund()
Gets the program fund id of the fund fiscal year.
|
void |
obligateAmount(curam.util.type.Money amount,
curam.codetable.impl.OBLIGATIONTRANSACTIONTYPEEntry transactionType,
long fundedItemID,
java.lang.String fundedItemType)
Obligates the specified amount using the transaction type against the fund
fiscal year.
|
void |
setFiscalYear(curam.fundpm.impl.FiscalYear fiscalYear)
Sets the fiscal year identifier of the fund fiscal year.
|
void |
setFund(curam.fundpm.impl.ProgramFund programFund)
Sets the program fund id of the fund fiscal year.
|
void |
setFundFiscalYearStatus(curam.codetable.impl.FUNDFISCALYEARSTATUSEntry status)
Sets the business status of the fund fiscal year.
|
void |
setRecordStatus(curam.codetable.impl.RECORDSTATUSEntry recordStatus)
Sets the status of the fund fiscal year.
|
void |
setTotalObligatedAmount(curam.util.type.Money totalObligatedAmount)
Sets the total obligated amount of the fund fiscal year.
|
getFundFiscalYearStatus, getRecordStatus, getTotalBudgetedAmount, getTotalObligatedAmount
curam.fundpm.impl.ProgramFund getFund()
getFund
in interface curam.fundpm.impl.FundFiscalYearAccessor
curam.fundpm.impl.FiscalYear getFiscalYear()
getFiscalYear
in interface curam.fundpm.impl.FundFiscalYearAccessor
void setFund(curam.fundpm.impl.ProgramFund programFund)
programFund
- Contains the program fund details.void setFiscalYear(curam.fundpm.impl.FiscalYear fiscalYear)
fiscalYear
- Contains fiscal year details.void setRecordStatus(curam.codetable.impl.RECORDSTATUSEntry recordStatus)
recordStatus
- The status of the fund fiscal year.@AccessLevel(value=EXTERNAL) boolean canObligate(curam.util.type.Money amount)
amount
- Amount to be obligated.void setFundFiscalYearStatus(curam.codetable.impl.FUNDFISCALYEARSTATUSEntry status)
status
- The business status of the fund fiscal year.void setTotalObligatedAmount(curam.util.type.Money totalObligatedAmount)
totalObligatedAmount
- The total obligated amount of the fund fiscal year.void obligateAmount(curam.util.type.Money amount, curam.codetable.impl.OBLIGATIONTRANSACTIONTYPEEntry transactionType, long fundedItemID, java.lang.String fundedItemType) throws curam.util.exception.InformationalException
amount
- Contains the amount details.transactionType
- Contains the transaction type.fundedItemID
- Contains the funded item ID.fundedItemType
- Contains the funded item type.curam.util.exception.InformationalException
- Generic Exception Signature.The default
implementation -
{@link curam.fundpm.impl.FundFiscalYearImpl#obligateAmount(Money, OBLIGATIONTRANSACTIONTYPEEntry, long, String)}
.