curam.cpm.facade.intf

Interface ProviderPaymentOptions

All Known Implementing Classes:

ProviderPaymentOptions, curam.cpm.facade.impl.ProviderPaymentOptions, ProviderPaymentOptionsFactory

@AccessLevel(value=EXTERNAL)
public interface ProviderPaymentOptions

This business interface manages the payment options for the services delivered by a provider. Where there is a mismatch between the rate that a provider invoices the organization and the service rate which is recorded on the system, a set of payment options are provided on the service, which dictate how the resulting payment should be handled. The payment options configured for a service can be overridden for a given provider. For example, if the fixed amount payment option for the child care service is configured to be 'Pay fixed amount', but the same payment option for the provider is configured to be 'Pay as billed', the provider will be paid at the rate specified on the service invoice, where the invoiced rate differs from the applicable service rate.

Method Summary

Modifier and Type	Method and Description
curam.cpm.sl.struct.PaymentOptionsKey	createProviderPaymentOptions(curam.cpm.facade.struct.PaymentOptionsDetails paymentOptionsDetails) Creates a payment options record for a service delivered by a provider.
curam.cpm.facade.struct.PaymentOptionsDetailsList	listProviderPaymentOptions(curam.cpm.sl.entity.struct.ProviderConcernRoleKey providerConcernRoleKey) Reads a list of payment options for a provider.
void	removeProviderPaymentOption(curam.cpm.facade.struct.KeyVersionDetails keyVersionDetails) Removes the payment options for a provider.
void	updateProviderPaymentOptions(curam.cpm.facade.struct.PaymentOptionsDetails paymentOptionsDetails) Modifies the details of a payment options record for a service delivered by a provider.
curam.cpm.facade.struct.PaymentOptionsDetails	viewPaymentOptions(curam.cpm.sl.struct.PaymentOptionsKey paymentOptionsKey) Reads the payment options details for a provider.

Method Detail

createProviderPaymentOptions

@AccessLevel(value=EXTERNAL)
curam.cpm.sl.struct.PaymentOptionsKey createProviderPaymentOptions(curam.cpm.facade.struct.PaymentOptionsDetails paymentOptionsDetails)
                                                                                         throws curam.util.exception.AppException,
                                                                                                curam.util.exception.InformationalException

Creates a payment options record for a service delivered by a provider. It also reassesses payments made to the provider in relation to the service.

Parameters:

paymentOptionsDetails - The details of the payment options.

Returns:

The key of the payment options.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

ServiceInvoiceLineItem

Business Object Write:

PaymentOptions, FinancialComponent

updateProviderPaymentOptions

@AccessLevel(value=EXTERNAL)
void updateProviderPaymentOptions(curam.cpm.facade.struct.PaymentOptionsDetails paymentOptionsDetails)
                                                        throws curam.util.exception.AppException,
                                                               curam.util.exception.InformationalException

Modifies the details of a payment options record for a service delivered by a provider. It also reassesses payments made to the provider in relation to the service.

Parameters:

paymentOptionsDetails - The details of the payment options.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

ServiceInvoiceLineItem

Business Object Write:

PaymentOptions, FinancialComponent

listProviderPaymentOptions

@AccessLevel(value=EXTERNAL)
curam.cpm.facade.struct.PaymentOptionsDetailsList listProviderPaymentOptions(curam.cpm.sl.entity.struct.ProviderConcernRoleKey providerConcernRoleKey)
                                                                                                   throws curam.util.exception.AppException,
                                                                                                          curam.util.exception.InformationalException

Reads a list of payment options for a provider.

Parameters:

providerConcernRoleKey - The key of the provider.

Returns:

The list of the payment options.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

PaymentOptions

viewPaymentOptions

@AccessLevel(value=EXTERNAL)
curam.cpm.facade.struct.PaymentOptionsDetails viewPaymentOptions(curam.cpm.sl.struct.PaymentOptionsKey paymentOptionsKey)
                                                                                       throws curam.util.exception.AppException,
                                                                                              curam.util.exception.InformationalException

Reads the payment options details for a provider.

Parameters:

paymentOptionsKey - The key of the payment options.

Returns:

The details of the payment options.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

removeProviderPaymentOption

@AccessLevel(value=EXTERNAL)
void removeProviderPaymentOption(curam.cpm.facade.struct.KeyVersionDetails keyVersionDetails)
                                                       throws curam.util.exception.AppException,
                                                              curam.util.exception.InformationalException

Removes the payment options for a provider.

Parameters:

keyVersionDetails - The key of the payment options and the version number.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

PaymentOptions