@AccessLevel(value=EXTERNAL) public interface FlatRateContract extends curam.contracts.impl.FlatRateContractAccessor, ContractVersion
The flat-rate contract establishes the terms under which the service(s) will be provided. The amount agreed will be paid to the provider on a regular basis regardless of utilization. For example a contract to deliver day care places at $500 per month.
Modifier and Type | Interface and Description |
---|---|
static interface |
FlatRateContract.FlatRateContractActivateEvents
Interface to the flat rate contract events functionality surrounding the
activate method.
|
static interface |
FlatRateContract.FlatRateContractCloneFlatRateContractEvents
Interface to the flat rate contract events functionality surrounding the
cloneFlatRateContract method.
|
static interface |
FlatRateContract.FlatRateContractDeleteEvents
Interface to the flat rate contract events functionality surrounding the
delete method.
|
static interface |
FlatRateContract.FlatRateContractGenerateEvents
Interface to the flat rate contract events functionality surrounding the
generate method.
|
static interface |
FlatRateContract.FlatRateContractInsertEvents
Interface to the flat rate contract events functionality surrounding the
insert method.
|
static interface |
FlatRateContract.FlatRateContractModifyEvents
Interface to the flat rate contract events functionality surrounding the
modify method.
|
static interface |
FlatRateContract.FlatRateContractReEditEvents
Interface to the flat rate contract events functionality surrounding the
reEdit method.
|
static interface |
FlatRateContract.FlatRateContractRenewEvents
Interface to the flat rate contract events functionality surrounding the
renew method.
|
static interface |
FlatRateContract.FlatRateContractTerminateEvents
Interface to the flat rate contract events functionality surrounding the
terminate method.
|
ContractVersion.ContractVersionInsertEvents, ContractVersion.ContractVersionModifyEvents, ContractVersion.ContractVersionPreviewContractEvents, ContractVersion.ContractVersionPrintContractEvents, ContractVersion.ContractVersionValidateContractedProviderOfferingPlaceLimitsEvents, ContractVersion.ContractVersionValidateContractedProviderOfferingRatesEvents
Modifier and Type | Method and Description |
---|---|
void |
activate(int versionNo)
Activates the flat-rate contract.
|
FlatRateContract |
cloneFlatRateContract(FlatRateContract existingContract,
curam.util.type.DateRange dateRange)
Creates a 'clone' of the flat-rate contract with the new start date and
status.
|
void |
delete(int versionNo)
Deletes the flat-rate contract.
|
void |
generate(int versionNo)
Generates the flat-rate contract.
|
void |
reEdit(int versionNo)
Modifies the flat-rate contract by transitioning to the In Edit state, if
valid to do so.
|
void |
renew(int versionNo,
curam.util.type.DateRange dateRange)
Renew a flat-rate contract, creates a new in edit version of the contract.
|
void |
setFrequency(curam.contracts.impl.ContractFrequencyEntry value)
Sets the contract frequency.
|
void |
setPaymentSpecification(curam.contracts.impl.PaymentSpecification value)
Sets the payment specification for the contract.
|
void |
setRegularPaymentAmt(curam.util.type.Money value)
Sets the regular payment amount.
|
void |
setTotalContractAmt(curam.util.type.Money value)
Sets the total contract amount.
|
void |
terminate(int versionNo)
Terminates the flat-rate contract.
|
getFrequency, getRegularPaymentAmt, getTotalContractAmt
getCommonApprovedProviderServiceOfferings, getContacts, getCPMContract, getProviderOfferings, getProviderOrganization, getProviders, getStatusHistory, previewContract, printContract, setContractServicesType, setCPMContract, setDateRange, setDateSigned, setGenerationDate, setGenerationReason, setProviderOrganization, setRenewedFromContractVersion, setRequiredLicenseType, setTerminationReason, validateContractedProviderOfferingPlaceLimits, validateContractedProviderOfferingRates
getAmendmentVersionNumber, getContractServicesType, getContractType, getCreatedBy, getDateSigned, getGenerationDate, getGenerationReason, getLastTransitionedBy, getRenewedContractInd, getRequiredLicenseType, getTerminationDateTime, getTerminationReason
void setTotalContractAmt(curam.util.type.Money value)
value
- the total contract amountThe default implementation -
curam.contracts.impl.FlatRateContractImpl#setTotalContractAmt(Money)
void setRegularPaymentAmt(curam.util.type.Money value)
value
- the regular payment amountThe default implementation -
curam.contracts.impl.FlatRateContractImpl#setRegularPaymentAmt(Money)
void setFrequency(curam.contracts.impl.ContractFrequencyEntry value)
value
- the contract frequency valuevoid setPaymentSpecification(curam.contracts.impl.PaymentSpecification value)
For example: Regular Payment Amount, Total Contract Amount, Frequency, Calculated Payment Amount, Calculated Last Payment Amount
value
- the Payment Specification of the contractvoid generate(int versionNo) throws curam.util.exception.InformationalException
Transitions the state to CONTRACTSTATUSEntry.ISSUED, if valid to do so.
versionNo
- version number as previously retrievedcuram.util.exception.InformationalException
- thrown if the record is not in a valid state.The default
implementation -
curam.contracts.impl.FlatRateContractImpl#generate(int)
@AccessLevel(value=EXTERNAL) void reEdit(int versionNo) throws curam.util.exception.InformationalException
versionNo
- Version number of the flat rate contract.curam.util.exception.InformationalException
FlatRateContract, UtilizationContract |
void activate(int versionNo) throws curam.util.exception.InformationalException
Transitions the state to CONTRACTSTATUSEntry.LIVE, if valid to do so.
versionNo
- version number as previously retrievedcuram.util.exception.InformationalException
- thrown if the record is not in a valid state.The default
implementation -
curam.contracts.impl.FlatRateContractImpl#activate(int)
void terminate(int versionNo) throws curam.util.exception.InformationalException
Transitions the state to CONTRACTSTATUSEntry.TERMINATED, if valid to do so.
versionNo
- version number as previously retrievedcuram.util.exception.InformationalException
- thrown if the record is not in a valid state.The default
implementation -
curam.contracts.impl.FlatRateContractImpl#terminate(int)
void delete(int versionNo) throws curam.util.exception.InformationalException
Transitions the state to CONTRACTSTATUSEntry.CANCELED, if valid to do so.
versionNo
- version number as previously retrievedcuram.util.exception.InformationalException
- thrown if the record is not in a valid state.The default
implementation - curam.contracts.impl.FlatRateContractImpl#delete(int)
void renew(int versionNo, curam.util.type.DateRange dateRange) throws curam.util.exception.InformationalException
versionNo
- version number as previously retrieveddateRange
- the date range for the renewed contractcuram.util.exception.InformationalException
- thrown if the record is not in a valid state.The default implementation -
curam.contracts.impl.FlatRateContractImpl#renew(int, DateRange).
FlatRateContract cloneFlatRateContract(FlatRateContract existingContract, curam.util.type.DateRange dateRange) throws curam.util.exception.InformationalException
existingContract
- the contract whose attributes are to be copieddateRange
- the start date, end date for the new contract versioncuram.util.exception.InformationalException
- thrown if the clone of the contract cannot created.The default implementation -
curam.contracts.impl.FlatRateContractImpl#cloneFlatRateContract(
FlatRateContract,DateRange)