@AccessLevel(value=EXTERNAL)
public interface FinancialAPI
Modifier and Type | Interface and Description |
---|---|
static interface |
FinancialAPI.FinancialAPIListReassessmentResultsEvents
Interface to the financial API events functionality surrounding the
listReassessmentResults method.
|
static interface |
FinancialAPI.FinancialAPIRetrievePaymentInformationEvents
Interface to the financial a p i events functionality surrounding the
retrievePaymentInformation method.
|
static interface |
FinancialAPI.FinancialAPIRetrievePaymentInformationForNomineeEvents
Interface to the financial a p i events functionality surrounding the
retrievePaymentInformationForNominee method.
|
static interface |
FinancialAPI.FinancialAPIRetrievePaymentInformationForServiceAuthorizationEvents
Interface to the financial a p i events functionality surrounding the
retrievePaymentInformation method.
|
static interface |
FinancialAPI.FinancialAPIRetrieveServiceDeliverySummaryInformationEvents
Interface to the financial a p i events functionality surrounding the
retrieveServiceDeliverySummaryInformation method.
|
static interface |
FinancialAPI.FinancialAPIRetrieveServiceDelivrySummaryInformationEvents
Interface to the financial API events functionality surrounding the
retrieveServiceDeliverySummaryInformation using case participant method.
|
Modifier and Type | Method and Description |
---|---|
boolean |
isPaymentMadeForProviderOfferingAndDateRange(ProviderOffering providerOffering,
curam.util.type.DateRange dateRange)
Indicates if there are any payments in the given date range for the
specified provider service.
|
curam.cpm.facade.struct.ReassessmentResultsList |
listReassessmentResults(ServiceAuthorization serviceAuthorization)
Lists the reassessment results for all the product deliveries created to
deliver the services for the given service authorization.
|
java.util.Set<PaymentInformation> |
retrievePaymentInformation(java.lang.Long caseID,
java.lang.Long clientID,
ServiceOffering serviceOffering)
Returns the list of payment details for a specified case, client and
service.
|
java.util.Set<PaymentInformation> |
retrievePaymentInformation(ProviderOffering providerOffering)
Returns a set of payment information for the specified provider service.
|
java.util.Set<PaymentInformation> |
retrievePaymentInformation(ServiceAuthorization serviceAuthorization)
Returns the list of payment details for a service authorization.
|
java.util.Set<curam.cpm.facade.struct.RetrievePaymentHistoryDetails> |
retrievePaymentInformationForNominee(java.lang.String nomineeReference,
ServiceOffering serviceOffering)
Retrieves payment information for a nominee.
|
curam.financial.impl.ServiceDeliverySummaryInformation |
retrieveServiceDeliverySummaryInformation(ServiceOffering serviceOffering,
java.lang.Long caseparticipantRoleID)
Reads the service delivery information such as earliest start date, the
latest end date and the total number of units consumed for a case
participant role and service.
|
curam.financial.impl.ServiceDeliverySummaryInformation |
retrieveServiceDeliverySummaryInformation(ServiceOffering serviceOffering,
java.lang.Long caseID,
java.lang.Long clientID)
Reads the service delivery summary information such as earliest start date,
the latest end date and the total number of units consumed for a specified
case, client and service.
|
@AccessLevel(value=EXTERNAL) java.util.Set<PaymentInformation> retrievePaymentInformation(java.lang.Long caseID, java.lang.Long clientID, ServiceOffering serviceOffering) throws curam.util.exception.AppException, curam.util.exception.InformationalException
caseID
- The key of the case.clientID
- The key of the client.serviceOffering
- The details of the service.curam.util.exception.AppException
curam.util.exception.InformationalException
ServiceInvoiceLineItem, InstructionLineItem, Placement, ProviderRosterLineItem |
@AccessLevel(value=EXTERNAL) java.util.Set<PaymentInformation> retrievePaymentInformation(ServiceAuthorization serviceAuthorization) throws curam.util.exception.AppException, curam.util.exception.InformationalException
serviceAuthorization
- The details of service authorization.curam.util.exception.AppException
curam.util.exception.InformationalException
ServiceInvoiceLineItem, InstructionLineItem, ProviderRosterLineItem |
@AccessLevel(value=EXTERNAL) curam.financial.impl.ServiceDeliverySummaryInformation retrieveServiceDeliverySummaryInformation(ServiceOffering serviceOffering, java.lang.Long caseID, java.lang.Long clientID)
serviceOffering
- The details of the service.caseID
- The key of the case.clientID
- The key of the client.ServiceInvoiceLineItem, ServiceDelivery, ProviderRosterLineItem |
@AccessLevel(value=EXTERNAL) curam.financial.impl.ServiceDeliverySummaryInformation retrieveServiceDeliverySummaryInformation(ServiceOffering serviceOffering, java.lang.Long caseparticipantRoleID)
serviceOffering
- The details of service.caseparticipantRoleID
- The key of the case participant.ServiceInvoiceLineItem, ServiceDelivery, ProviderRosterLineItem |
java.util.Set<curam.cpm.facade.struct.RetrievePaymentHistoryDetails> retrievePaymentInformationForNominee(java.lang.String nomineeReference, ServiceOffering serviceOffering) throws curam.util.exception.AppException, curam.util.exception.InformationalException
nomineeReference
- Contains the system generated identifier for the nominee.serviceOffering
- Contains service offering details.curam.util.exception.AppException
- Generic Exception Signature.curam.util.exception.InformationalException
- Generic Exception Signature.curam.cpm.facade.struct.ReassessmentResultsList listReassessmentResults(ServiceAuthorization serviceAuthorization) throws curam.util.exception.AppException, curam.util.exception.InformationalException
serviceAuthorization
- the service authorization object.curam.util.exception.AppException
- Generic Exception Signature.curam.util.exception.InformationalException
- Generic Exception Signature.@AccessLevel(value=EXTERNAL) java.util.Set<PaymentInformation> retrievePaymentInformation(ProviderOffering providerOffering) throws curam.util.exception.AppException, curam.util.exception.InformationalException
providerOffering
- The provider service information.curam.util.exception.AppException
curam.util.exception.InformationalException
ServiceInvoiceLineItem, InstructionLineItem, Placement, ProviderRosterLineItem |
@AccessLevel(value=EXTERNAL) boolean isPaymentMadeForProviderOfferingAndDateRange(ProviderOffering providerOffering, curam.util.type.DateRange dateRange) throws curam.util.exception.AppException, curam.util.exception.InformationalException
providerOffering
- The provider service information.dateRange
- The date range to be considered.curam.util.exception.AppException
curam.util.exception.InformationalException
ServiceInvoiceLineItem, InstructionLineItem, Placement, ProviderRosterLineItem |