ProductDelivery (core)

All Known Implementing Classes:

ProductDelivery, curam.core.facade.impl.ProductDelivery, ProductDeliveryFactory
```
@AccessLevel(value=EXTERNAL)
public interface ProductDelivery
```
This is the business interface to the product delivery functionality. A product delivery is a type of case that is used to deliver care and protection to clients in the form of benefits. A product delivery is created within an integrated case by default so that integrated case functionality can be used for that product delivery. For example, evidence can be captured at the integrated case level and shared between product deliveries for the same person or for persons within the same family.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`curam.core.struct.EligibilityMessageList`	`activate(curam.core.facade.struct.ActivateCaseKey_fo key)` Activates a product delivery and uses delayed processing to determine the initial eligibility for the product delivery.
`curam.core.facade.struct.InformationMsgDtlsList`	`activateDeduction(curam.core.facade.struct.DeductionItemKeyVersionNo key)` Activates a case deduction.
`void`	`approve(curam.core.facade.struct.ProductDeliveryApprovalKey key)` Approves a product delivery.
`curam.core.facade.struct.BenefitStatementDetailsList`	`benefitStatementBreakdownExists(curam.core.facade.struct.BenefitStatementKey key)` Determine whether a summarized statement of the over/under payment details in the form of breakdown information is available for the benefit statement when viewing the reassessment details.
`void`	`cancelCertification(curam.core.facade.struct.CancelCertificationKey key)` Cancels the certification on a product delivery.
`void`	`cancelDeduction(curam.core.facade.struct.CancelDeductionKey details)` Cancels a product delivery deduction.
`void`	`cancelMilestone(curam.core.sl.entity.struct.MilestoneDeliveryKey key)` Cancels a milestone for a product delivery.
`curam.core.facade.struct.EvaluateCaseResult`	`checkEligibility(curam.core.facade.struct.CheckEligibilityDetails key)` Checks that the product delivery supports assessment and if so checks the eligibility on a given date or on the case start date.
`curam.core.facade.infrastructure.assessment.struct.CaseDeterminationDecisionDetailsList`	`checkEligibilityCaseDetermination(curam.core.facade.struct.CheckEligibilityCaseDeterminationDetails key)` Checks the eligibility of a product delivery and returns a list of decisions for the overall pre-release eligibility determination.
`void`	`close(curam.core.facade.struct.CloseCaseDetails details)` Closes a product delivery using delayed processing and records closure details.
`curam.core.struct.DecisionDifferenceDetails`	`compareChangedEvidenceOnly(curam.core.facade.struct.CompareDecisionEvidenceKey key)` Compares two sets of decision evidence for a product delivery and returns the differences.
`curam.core.facade.struct.CompareDecisionEvidenceResult`	`compareDecisionEvidence(curam.core.facade.struct.CompareDecisionEvidenceKey key)` Compares two sets of decision evidence for a product delivery and returns the differences.
`curam.core.facade.struct.CompareRuleEvidenceResult`	`compareRuleEvidence(curam.core.facade.struct.CompareRuleEvidenceKey key)` Compares two sets of rule evidence for a product delivery and returns the differences.
`curam.core.facade.struct.InformationMsgDtlsList`	`createActiveFixedDeduction(curam.core.facade.struct.FixedDeductionDetails1 details)` Creates and activates a fixed deduction for the product delivery.
`curam.core.facade.struct.InformationMsgDtlsList`	`createActiveThirdPartyFixedDeduction(curam.core.facade.struct.ThirdPartyFixedDeductionDetails1 details)` Creates and activates a third party deduction for a product delivery.
`curam.core.facade.struct.InformationMsgDtlsList`	`createActiveThirdPartyVariableDeduction(curam.core.facade.struct.ThirdPartyVariableDeductionDetails1 details)` Creates and activates a third party variable deduction for a product delivery.
`curam.core.facade.struct.InformationMsgDtlsList`	`createActiveVariableDeduction(curam.core.facade.struct.CreateDeductionDetails1 details)` Creates and activates a variable deduction for a product delivery.
`curam.core.facade.struct.CreateAssessmentDeliveryDetails`	`createAssessment(curam.core.facade.struct.CreateAssessmentDeliveryKey key)` Creates an assessment on a product delivery and assigns the owner the appropriate role.
`curam.core.facade.struct.CreatedCaseIDKey`	`createCase(curam.core.facade.struct.CreateCaseDetails details)` Creates a product delivery and links the clients' participant evidence to it.
`curam.core.facade.struct.InformationMsgDtlsList`	`createCertification(curam.core.facade.struct.CreateCertificationDetails details)` Creates a certification on a product delivery.
`curam.core.facade.struct.InformationMsgDtlsList`	`createFixedDeduction1(curam.core.facade.struct.FixedDeductionDetails1 details)` Creates a new fixed deduction on a product delivery and fires the create deduction workflow event.
`curam.core.sl.entity.struct.MilestoneDeliveryKey`	`createMilestone(curam.core.sl.struct.MilestoneDeliveryDtls dtls)` Creates a milestone for this product delivery and fires the milestone created workflow event.
`curam.core.facade.struct.RepresentativeID`	`createNomineeRepresentativeWithTextBankAccountSortCode(curam.core.facade.struct.RepresentativeRegistrationWithTextBankAccountSortCodeDetails dtls)` Creates a representative of type nominee.
`curam.core.facade.struct.InformationMsgDtlsList`	`createThirdPartyFixedDeduction1(curam.core.facade.struct.ThirdPartyFixedDeductionDetails1 details)` Creates a third party fixed deduction on a product delivery and fires the create deduction workflow event.
`curam.core.facade.struct.InformationMsgDtlsList`	`createThirdPartyVariableDeduction1(curam.core.facade.struct.ThirdPartyVariableDeductionDetails1 details)` Creates a third party variable deduction on a product delivery and fires the create deduction event.
`void`	`createUtilityPayment(curam.core.facade.struct.CreateUtilityPaymentDetails details)` Creates a utility payment on a product delivery and triggers a regeneration of the financials.
`curam.core.facade.struct.InformationMsgDtlsList`	`createVariableDeduction1(curam.core.facade.struct.CreateDeductionDetails1 details)` Creates a variable deduction on a product delivery and fires the create deduction workflow event.
`void`	`deactivateDeduction(curam.core.facade.struct.DeductionItemKeyVersionNo key)` Deactivates a deduction, records a deduction history record and then regenerates the financials.
`void`	`generatePayment(curam.core.facade.struct.GeneratePaymentKey key)` Generates a payment for a product delivery based on the status of the product delivery and the configured application properties (e.g.
`curam.core.facade.struct.BenefitOverpaymentEvidenceResult`	`getBenefitOverpaymentEvidence(curam.core.struct.CaseHeaderKey key)` Returns the benefit overpayment evidence details.
`curam.core.struct.ConcernRoleID`	`getDeductionClient(curam.core.facade.struct.DeductionClientDetails details)` Returns a concern role identifier for the specified deduction client.
`curam.core.facade.struct.ReadDeductionAmount`	`getDefaultAmountForDeduction(curam.core.facade.struct.ReadFinInstructionIDAndDeductionDetails readFinInstructionIDAndDeductionDetails)` Returns the default deduction amount.
`curam.core.facade.struct.ListDecisionDetails`	`listActiveDecision(curam.core.facade.struct.ListDecisionKey key)` Returns a list of the active decisions for a product delivery.
`curam.core.facade.struct.DeductionList`	`listActiveDeduction(curam.core.facade.struct.ListCaseDeductionsKey key)` Lists the active deductions on a product delivery.
`curam.core.facade.struct.ListActiveLiabilityDetails`	`listActiveLiabilitiesForConcern(curam.core.facade.struct.ListActiveLiabilitesForConcernKey key)` Returns details of all active liability cases for the specified concern role against which deductions can be applied.
`curam.core.facade.struct.ListActiveLiabilityDetails1`	`listActiveLiabilitiesForConcernRole(curam.core.facade.struct.ListActiveLiabilitesForConcernKeyStruct key)` Returns a list of the active liabilities for a concern with the original amount and balance outstanding for each liability.
`curam.core.facade.struct.ListPDAdminCaseRoleDetails`	`listAdminCaseRole(curam.core.facade.struct.ListAdminCaseRoleKey key)` Returns a list of the administrator case roles on a product delivery.
`curam.core.facade.struct.DeductionList`	`listAppliedAndUnappliedDeduction(curam.core.facade.struct.ListCaseDeductionsKey key)` List the applied or un-applied deductions on the product delivery.
`curam.core.facade.struct.CaseAppliedDeductionHistoryDetailsList`	`listAppliedDeductionHistory(curam.core.facade.struct.CaseDeductionHistoryListKey key)` Lists the deduction history for an applied deduction.
`curam.core.facade.struct.DeductionNameList`	`listAppliedDeductionName(curam.core.facade.struct.CaseIDKey key)` Lists all applied deduction names and their associated categories and priorities.
`curam.core.facade.struct.ListAssessmentForProductDelivery`	`listAssessment(curam.core.facade.struct.CaseKey_fo key)` Returns a list of assessments on a product delivery.
`curam.core.facade.struct.ListAttachmentDetails`	`listAttachment(curam.core.facade.struct.ListAttachmentsKey key)` Returns the list of attachments on a product delivery.
`curam.core.facade.struct.BenefitStatementDetailsList`	`listBenefitStatementDetails(curam.core.facade.struct.BenefitStatementKey key)` Returns a list of details to be displayed on the benefit statement.
`curam.core.facade.struct.BenefitStatementDetailsList`	`listBenefitStatementDetailsNoBreakdown(curam.core.facade.struct.BenefitStatementKey key)` Displays a list of reassessment details to be displayed on a statement page where there is no breakdown information available for that benefit statement.
`curam.core.facade.struct.ViewCaseFinancialInstructionList`	`listCaseFinancialInstruction(curam.core.facade.struct.ListCaseFinancialsKey key)` List the financial instructions associated with this product delivery.
`curam.core.facade.struct.SimulationsByCaseIDList`	`listCasePaymentSimulations(curam.core.struct.CaseKey caseKey)` Returns a list of the payment simulations for the product delivery.
`curam.core.facade.struct.ListCertificationDetails1`	`listCertification1(curam.core.facade.struct.CertificationCaseIDKey key)` Returns a list of the certifications for a product delivery.
`curam.core.facade.struct.ListPDClientRoleDetails`	`listClientRole(curam.core.facade.struct.ListClientRoleKey key)` Returns a list of the case participant client roles on a product delivery.
`curam.core.facade.struct.ListPDDeliveryPatternHistoryDetails_fo`	`listCurrentDeliveryPattern(curam.core.sl.struct.ProductDeliveryPatternByCaseIDKey key)` Returns a list of delivery pattern details for the specified product delivery.
`curam.core.facade.struct.ListDecisionDetails`	`listDecision(curam.core.facade.struct.ListDecisionKey key)` Returns a list of decisions on a product delivery.
`curam.core.facade.struct.ListObjectiveDeductableDetails`	`listDeductableObjectives(curam.core.facade.struct.ListDeductableObjectivesKey key)` Returns a list of the objectives on the product delivery against which a deduction can be created.
`curam.core.facade.struct.ListDeductionDetails`	`listDeduction(curam.core.facade.struct.ListCaseDeductionsKey key)` Returns a list of the deductions on the product delivery.
`curam.core.facade.struct.ListObjectiveDeductionDetails`	`listDeductionsForObjective(curam.core.facade.struct.ListDeductionsForObjectiveKey key)` Returns the list of deductions for a rules objective.
`curam.core.facade.struct.ListPDDeliveryPatternHistoryDetails_fo`	`listDeliveryPatternInfoDetails(curam.core.sl.struct.ProductDeliveryPatternByCaseIDKey key)` Returns a list of the delivery pattern details for a specified product delivery.
`curam.core.facade.struct.ListEventDetails1`	`listEvent1(curam.core.facade.struct.ListEventKey key)` Returns a list of the events on a product delivery.
`curam.core.facade.struct.ListPDEvidenceDetails`	`listEvidence(curam.core.facade.struct.ListEvidenceKey key)` List the evidence associated with the product delivery.
`curam.core.facade.struct.ListEvidenceUsedByRuleResult`	`listEvidenceUsedByRule(curam.core.facade.struct.ListEvidenceUsedByRuleKey key)` Lists the evidence item names and values along with a legislation name and rule name for a rule.
`curam.core.struct.FilteredReassessmentDecisionsDetailsList`	`listFilteredDecisionsForReassessmentPeriod(curam.core.struct.ReassessmentInfoKey key)` Lists the decision pairs, based on the given reassessment information identifier.
`curam.core.sl.struct.InvestigationDeliveryDetailsList`	`listInvestigation(curam.core.struct.CaseHeaderKey key)` Returns a list of the investigations related to this product delivery.
`curam.core.facade.struct.ICInvestigationDeliveryClientRoleList`	`listInvestigationDeliveryCaseMembers(curam.core.struct.CaseHeaderKey key)` Returns a list of the case members involved in this investigation.
`curam.core.facade.struct.ListLocationDetails`	`listLocation(curam.core.facade.struct.ListLocationKey key)` Returns a list of the location details for the product delivery.
`curam.core.facade.struct.ListMilestoneForProductDeliveryDetails`	`listMilestone(curam.core.struct.CaseHeaderKey key)` Returns a list of the milestone details for the product delivery.
`curam.core.facade.struct.ListNoteDetails1`	`listNote1(curam.core.facade.struct.ListNoteKey key)` Returns a list of the notes on a product delivery.
`curam.core.sl.struct.OutcomeNameAndIDDetailsList`	`listOutcomesForCase(curam.core.facade.struct.ListOutcomesKey key)` Returns a list of the expected outcomes for the product delivery.
`curam.core.facade.struct.ListOverUnderPaymentDetails`	`listOverUnderPayment(curam.core.facade.struct.ListOverUnderPaymentKey key)` Returns a list of over / under payments for a product delivery.
`curam.core.facade.struct.OverUnderPaymentBreakdownDetailsList`	`listOverUnderPaymentBreakdown(curam.core.facade.struct.ReadOverUnderPaymentDetailsKey key)` Returns a list of reassessment results broken down by component.
`curam.core.facade.struct.UtilityProductComponentList`	`listProductComponent(curam.core.facade.struct.UtilityPaymentCaseKey key)` Returns a list of product components that are applicable to the specified case.
`curam.core.facade.struct.ListReassessmentDecisionResult`	`listReassessmentPeriodDecision(curam.core.facade.struct.ListDecisionsForReassessmentPeriodKey key)` Returns a list of decisions for the reassessment period.
`curam.core.facade.struct.ReassessmentResultDetailsList`	`listReassessmentResults(curam.core.facade.struct.ListOverUnderPaymentKey key)` Returns the list of reassessment results for a specified product delivery.
`curam.core.facade.struct.ListRelationshipCaseDetails`	`listRelationship(curam.core.facade.struct.ListCaseRelationshipKey key)` Returns a list of cases that have case relationships with the product delivery.
`curam.core.struct.FilteredReassessmentDecisionsDetails`	`listSingleReassessmentPeriodDecision(curam.core.facade.struct.ListDecisionsForReassessmentPeriodKey key)` Returns the relevant pair of decisions for the given reassessment period or NULL if more than one pair is found.
`curam.core.facade.struct.CaseAppliedDeductionHistoryDetailsList1`	`listSortedAppliedDeductionHistory(curam.core.facade.struct.CaseDeductionHistoryListKey key)` Returns a deduction history for an applied case deduction, sorted by effective date.
`curam.core.facade.struct.CaseThirdPartyDeductionHistoryDetailsList1`	`listSortedThirdPartyDeductionHistory(curam.core.facade.struct.CaseDeductionHistoryListKey key)` Returns a deduction history for a third party case deduction sorted by effective date.
`curam.core.facade.struct.CaseUnappliedDeductionHistoryDetailsList1`	`listSortedUnappliedDeductionHistory(curam.core.facade.struct.CaseDeductionHistoryListKey key)` Returns a deduction history for an un-applied case deduction sorted by effective date.
`curam.core.facade.struct.ListProductDeliveryStatusHistoryDetails1`	`listStatusHistory1(curam.core.facade.struct.ListProductDeliveryStatusHistoryKey key)` Returns a case status history for a product delivery.
`curam.core.facade.struct.DeductionList`	`listThirdPartyDeduction(curam.core.facade.struct.ListCaseDeductionsKey key)` Returns a list of all third party case deductions.
`curam.core.facade.struct.CaseThirdPartyDeductionHistoryDetailsList`	`listThirdPartyDeductionHistory(curam.core.facade.struct.CaseDeductionHistoryListKey key)` Returns a deduction history for a third party case deduction.
`curam.core.facade.struct.DeductionNameList`	`listThirdPartyDeductionName(curam.core.facade.struct.CaseIDKey key)` Returns a list of all third party deduction names and their associated categories and priorities for a product delivery.
`curam.core.facade.struct.CaseUnappliedDeductionHistoryDetailsList`	`listUnappliedDeductionHistory(curam.core.facade.struct.CaseDeductionHistoryListKey key)` Returns a deduction history for an un-applied case deduction.
`curam.core.facade.struct.DeductionNameList`	`listUnappliedDeductionName(curam.core.facade.struct.CaseIDKey key)` Returns a list of all un-applied deduction names and their associated categories and priorities for a product delivery.
`curam.core.facade.struct.ListMilestoneForProductDeliveryDetails`	`listUncompletedMilestone(curam.core.struct.CaseHeaderKey key)` Returns a list of milestones for the product delivery which have a status of 'not started' or 'in progress'.
`curam.core.facade.struct.UnprocessedILIDetailsList`	`listUnprocessedILIs(curam.core.struct.SearchUnprocessedByCaseIDKey searchUnprocessedKey)` Returns a list of the unprocessed ILIs (Instruction Line Items) for the product delivery.
`curam.core.facade.struct.ListUtilityPayments`	`listUtilityPayment(curam.core.facade.struct.ListUtilityPaymentKey key)` Returns a list of the utility payments made to a concern role.
`curam.core.facade.struct.InformationMsgDtlsList`	`modifyCaseDeductionItem1(curam.core.facade.struct.ModifyCaseDeductionItemDetails1 details)` Modifies the details for a case deduction.
`curam.core.facade.struct.InformationMsgDtlsList`	`modifyCertification(curam.core.facade.struct.MaintainCertificationDetails details)` Modifies the certification details for a product delivery case.
`void`	`modifyCertificationFrequency(curam.core.facade.struct.ModifyCertificationFrequencyDetails details)` Modifies the certification frequency on a product delivery.
`void`	`modifyClosureDetails(curam.core.facade.struct.ClosureDetails details, curam.core.facade.struct.ModifyClosureDetailsKey key)` Modifies the closure details for a product delivery case.
`void`	`modifyDeductionItem(curam.core.struct.MaintainDeductionItemDetails details)` Modifies the deduction details.
`curam.core.facade.struct.InformationMsgDtlsList`	`modifyDeliveryPattern(curam.core.facade.struct.ModifyDeliveryPatternDetails details)` Modifies the delivery pattern details for a product delivery.
`curam.core.facade.struct.InformationMsgDtlsList`	`modifyHeader(curam.core.facade.struct.ModifyHeaderDetails details)` Modifies the details of a product delivery header.
`void`	`modifyLocation(curam.core.facade.struct.ProductDeliveryModifyLocationDetails details)` Modifies the location details for a product delivery.
`void`	`modifyMilestone(curam.core.sl.struct.MilestoneDeliveryDtls dtls)` Modifies the milestone details for a product delivery.
`void`	`modifyMilestoneForWaiver(curam.core.sl.struct.MilestoneDeliveryDtls details)` Modifies the product delivery milestone details for a milestone waiver.
`curam.core.facade.struct.InformationMsgDtlsList`	`modifyThirdPartyDeductionItem(curam.core.facade.struct.ModifyThirdPartyDeductionDetails details)` Modifies details for a third party case deduction.
`curam.core.facade.struct.InformationMsgDtlsList`	`processThirdPartyFixedDeduction(curam.core.facade.struct.ThirdPartyDeductionActivationStruct details)` Saves and activates or just saves a third party fixed deduction based on the value of the indicator passed in.
`curam.core.facade.struct.InformationMsgDtlsList`	`processThirdPartyVariableDeduction(curam.core.facade.struct.ThirdPartyDeductionActivationStruct details)` Saves and activates or just saves a third party variable deduction based on the value of the indicator passed in.
`void`	`reactivate(curam.core.facade.struct.ReactivationDetails details)` Reopens a Product Delivery case with status as either Closed or Pending Closure.
`curam.core.facade.struct.ParticipantWithoutProspectTypeDescList`	`readAppliedDeductionParticipantsWithoutProspect()` Returns a list of the participant types the user can search on when creating an applied deduction.
`curam.core.facade.struct.BenefitUnderpmtHomePageDetails1`	`readBenefitUnderpmtHomePageDetails1(curam.core.facade.struct.ReadHomePageKey key)` Reads the details required to populate the benefit underpayment home page.
`curam.core.facade.struct.ActivityAttendeeTypeDescList`	`readCaseEventInvitedAttendeeParticipants()` Reads the application property to see which participant types the user can search on when inviting an attendee to an activity.
`curam.core.facade.struct.ReadCertificationDetails`	`readCertification(curam.core.facade.struct.MaintainCertificationKey key)` Reads the certification details for a product delivery.
`curam.core.facade.struct.CertificationFrequencyDetails`	`readCertificationFrequency(curam.core.facade.struct.ReadProductDeliveryFreqKey key)` Reads the certification frequency of a product delivery.
`curam.core.facade.struct.ClosureDetails`	`readClosureDetails(curam.core.facade.struct.ReadCaseClosureKey key)` Reads the closure details for a product delivery.
`curam.core.facade.struct.ReadCaseDecisionDetails`	`readDecision(curam.core.facade.struct.ReadCaseDecisionKey key)` Read a case decision for a product delivery.
`curam.core.facade.struct.ReadDeductionAndHeaderDetails`	`readDeduction1(curam.core.facade.struct.ReadDeductionKey key)` Reads the details of an applied deduction.
`curam.core.facade.struct.DeductionCategory`	`readDeductionCategory(curam.core.facade.struct.ReadDeductionKey key)` Reads the category for a case deduction.
`curam.core.struct.DeductionHeaderDetails`	`readDeductionLiabilityDetails(curam.core.sl.struct.CaseIDKey key)` Reads the deduction details to be displayed on the create deduction details page.
`curam.core.struct.InformationalMsgDtlsList`	`readDeductionPaymentDetails(curam.core.facade.struct.ReadFinInstructionIDAndDeductionDetails readFinInstructionIDAndDeductionDetails)` Reads the deduction payment for a product delivery.
`curam.core.facade.struct.DefaultDeductionDetails`	`readDefaultDeductionDetails(curam.core.facade.struct.DefaultDeductionKey key)` Reads the initial data for the creation of applied, fixed and variable deductions.
`curam.core.facade.struct.ReadHeaderResult`	`readHeader1(curam.core.facade.struct.ReadHeaderKey key)` Reads details of the product delivery header.
`curam.core.facade.struct.ReadHomePageDetails1`	`readHomePageDetails1(curam.core.facade.struct.ReadHomePageKey key)` Reads the details to populate a product delivery home page.
`curam.core.struct.InformationalMsgDtlsList`	`readLastPaymentDate(curam.core.facade.struct.CaseIDKey key)` Reads the last payment date for a product delivery.
`curam.core.facade.struct.LiabilityOverbillingHomePageDetails1`	`readLiabilityOverbillingHomePageDetails1(curam.core.facade.struct.ReadHomePageKey key)` Reads the home page details for a liability overbilling product delivery.
`curam.core.facade.struct.ReadMilestoneDeliveryDetails`	`readMilestone(curam.core.sl.entity.struct.MilestoneDeliveryKey key)` Reads the milestone details for a product delivery milestone.
`curam.core.facade.struct.ReadOverUnderPaymentDetails`	`readOverUnderPayment(curam.core.facade.struct.ReadOverUnderPaymentDetailsKey key)` Reads the over/under payment details.
`curam.core.struct.ProductIDDetails`	`readProductID(curam.core.sl.struct.CaseIDKey key)` Reads the product identifier for a product delivery.
`curam.core.struct.ProductDeliveryTypeDetails`	`readProductType(curam.core.struct.ProductDeliveryKey productDeliveryKey)` Reads the product type for a product delivery.
`curam.core.facade.struct.RelatedCaseID`	`readRelatedCaseID(curam.core.facade.struct.ReadDeductionKey key)` Reads the related case identifier for a deduction.
`curam.core.facade.struct.RelatedCaseIDThirdPartyID`	`readRelatedCaseIDAndThirdPartyID(curam.core.facade.struct.ReadDeductionKey key)` Reads the related case identifier and the third party concern role identifier for a case deduction.
`curam.core.facade.struct.ReadPaymentSimulationDetails`	`readSimulationDetails(curam.core.struct.SimulationHeaderKey key)` Returns the details of a payment simulation.
`curam.core.facade.struct.CaseStatusDetails`	`readStatusHistory(curam.core.facade.struct.CaseStatusKey key)` Reads the product delivery status history.
`curam.core.facade.struct.ParticipantWithoutProspectTypeDescList`	`readThirdPartyDeductionParticipantsWithoutProspect()` Reads an application property to see which participant types the user can search on when they are creating a third party deduction.
`curam.core.facade.struct.ReassessBenefitDetails`	`reassessBenefit(curam.core.facade.struct.ReassessBenefitKey key)` Reassesses a benefit product delivery.
`curam.core.facade.struct.ReassessCreoleDetails`	`reassessCaseDetermination(curam.core.facade.struct.ReassessCreoleKey key)` Reassesses the case determination on the product delivery.
`curam.core.facade.struct.ReassessLiabilityDetails`	`reassessLiability(curam.core.facade.struct.ReassessLiabilityKey key)` Reassesses a liability case.
`void`	`reject1(curam.core.facade.struct.RejectCaseKey_fo1 key)` Rejects a product delivery.
`void`	`removeAllSimulations(curam.core.struct.CaseKey caseKey)` Remove all of the saved payment simulations for a product delivery.
`void`	`removeSimulation(curam.core.struct.SimulationHeaderID key)` Removes a saved payment simulation.
`curam.core.struct.SimulatePaymentResult1`	`saveOrSimulatePayment(curam.core.facade.struct.SimulationDetails details)` Either saves or simulates a payment based on the action selected on the client.
`void`	`saveSimulationDetails1(curam.core.facade.struct.SimulationDetails details)` Saves the details of the simulation.
`void`	`setOverrideMDRInd(curam.core.struct.ProductDeliveryKey key, curam.core.struct.CuramInd details)` Sets the override max deduction rate indicator for a product delivery to true.
`curam.core.struct.SimulatePaymentResult1`	`simulatePayment1(curam.core.facade.struct.SimulationDetails details)` Simulate a payment on a particular product delivery for the given date.
`curam.core.struct.ApprovalMessageList`	`submit(curam.core.facade.struct.SubmitForApprovalKey key)` Submits a product delivery for approval.
`void`	`suspend(curam.core.facade.struct.ProductDeliverySuspensionKey key)` Suspends a product delivery.
`void`	`unsetOverrideMDRInd(curam.core.struct.ProductDeliveryKey key, curam.core.struct.CuramInd details)` Unsets the override max deduction rate indicator for a product delivery by modifying it to false.
`void`	`unsuspend(curam.core.facade.struct.ProductDeliveryUnsuspensionKey key)` Unsuspend a product delivery and set the status to 'open'.
`curam.core.facade.struct.InformationMsgDtlsList`	`userActionFixedDeduction(curam.core.facade.struct.DeductionActivationDetails details)` Save and activate or just save a fixed deduction based on the action selected on the client.
`curam.core.facade.struct.InformationMsgDtlsList`	`userActionVariableDeduction(curam.core.facade.struct.DeductionActivationDetails details)` Saves and activates or just saves a variable deduction based on the action selected on the client.
`curam.core.facade.struct.PDApprovalRequestDetails`	`viewApprovalRequest(curam.core.facade.struct.PDApprovalRequestKey pdApprovalRequestIDKey)` Reads details of a product delivery approval request.

Method Detail

activate
```
@AccessLevel(value=EXTERNAL)
curam.core.struct.EligibilityMessageList activate(curam.core.facade.struct.ActivateCaseKey_fo key)
                                                                        throws curam.util.exception.AppException,
                                                                               curam.util.exception.InformationalException
```
Activates a product delivery and uses delayed processing to determine the initial eligibility for the product delivery.

Parameters:

key - The product delivery identifier.

Returns:

A list of eligibility assessment messages.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:
CaseStatus

Business Object Write:
ProductDelivery, CaseStatus

activateDeduction

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.InformationMsgDtlsList activateDeduction(curam.core.facade.struct.DeductionItemKeyVersionNo key)
                                                                                        throws curam.util.exception.AppException,
                                                                                               curam.util.exception.InformationalException

Activates a case deduction. The financials for the product delivery are regenerated.

Parameters:

key - The deduction item identifier.

Returns:

A list of informational messages.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

Deduction

approve
```
@AccessLevel(value=EXTERNAL)
void approve(curam.core.facade.struct.ProductDeliveryApprovalKey key)
                                   throws curam.util.exception.AppException,
                                          curam.util.exception.InformationalException
```
Approves a product delivery.

Parameters:

key - The product delivery idetifier.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:
CaseStatus, CaseUserRole, CaseApproval, ProductDelivery, Decision, Product

Business Object Write:
CaseApproval, ProductDelivery, CaseStatus, CaseEvent

cancelCertification

@AccessLevel(value=EXTERNAL)
void cancelCertification(curam.core.facade.struct.CancelCertificationKey key)
                                               throws curam.util.exception.AppException,
                                                      curam.util.exception.InformationalException

Cancels the certification on a product delivery.

Parameters:

key - The product delivery identifier.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

CertificationDiary, ProductDelivery

cancelDeduction
```
@AccessLevel(value=EXTERNAL)
void cancelDeduction(curam.core.facade.struct.CancelDeductionKey details)
                                           throws curam.util.exception.AppException,
                                                  curam.util.exception.InformationalException
```
Cancels a product delivery deduction. The cancellation is recorded in the deduction history. If the deduction is cancelled because the product delivery is suspended any related, active financial components are also cancelled.

Parameters:

key - The deduction identifier.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:
Deduction, FinancialComponent

cancelMilestone
```
@AccessLevel(value=EXTERNAL)
void cancelMilestone(curam.core.sl.entity.struct.MilestoneDeliveryKey key)
                                           throws curam.util.exception.AppException,
                                                  curam.util.exception.InformationalException
```
Cancels a milestone for a product delivery. All related events or milestone waiver approval requests are also cancelled.

Parameters:

key - The milestone identifier.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:
CaseEvent

Business Object Write:
Milestone, CaseEvent

checkEligibility
```
@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.EvaluateCaseResult checkEligibility(curam.core.facade.struct.CheckEligibilityDetails key)
                                                                                   throws curam.util.exception.AppException,
                                                                                          curam.util.exception.InformationalException
```
Checks that the product delivery supports assessment and if so checks the eligibility on a given date or on the case start date.

Parameters:

key - The identifier for the product delivery, the evaluation date and identifiers to specify if active evidence and/or the case start date should be used for the reassessment.

Returns:

A list of claim results from the product delivery assessment.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:
ProductDelivery, Assessment

Business Object Write:
Assessment

checkEligibilityCaseDetermination

@AccessLevel(value=EXTERNAL)
curam.core.facade.infrastructure.assessment.struct.CaseDeterminationDecisionDetailsList checkEligibilityCaseDetermination(curam.core.facade.struct.CheckEligibilityCaseDeterminationDetails key)
                                                                                                                                                throws curam.util.exception.AppException,
                                                                                                                                                       curam.util.exception.InformationalException

Checks the eligibility of a product delivery and returns a list of decisions for the overall pre-release eligibility determination.

Parameters:

key - The product delivery identifier and indicators to show if the eligibility is to be checked for active evidence and from which date.

Returns:

A list of the resulting eligibility determinations.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

ProductDelivery, Assessment, Determination

Business Object Write:

Assessment, Determination

close
```
@AccessLevel(value=EXTERNAL)
void close(curam.core.facade.struct.CloseCaseDetails details)
                                 throws curam.util.exception.AppException,
                                        curam.util.exception.InformationalException
```
Closes a product delivery using delayed processing and records closure details. Any tasks that are outstanding on the product delivery are closed if the property close case with active tasks application property is set to true.

Parameters:

key - The product delivery closure details.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:
ProductDelivery, CaseUserRole, CaseStatus

compareDecisionEvidence

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.CompareDecisionEvidenceResult compareDecisionEvidence(curam.core.facade.struct.CompareDecisionEvidenceKey key)
                                                                                                     throws curam.util.exception.AppException,
                                                                                                            curam.util.exception.InformationalException

Compares two sets of decision evidence for a product delivery and returns the differences.

Parameters:

key - The identifiers for the decisions being compared.

Returns:

The differences between the decisions.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

ProductDelivery, Decision

compareRuleEvidence

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.CompareRuleEvidenceResult compareRuleEvidence(curam.core.facade.struct.CompareRuleEvidenceKey key)
                                                                                             throws curam.util.exception.AppException,
                                                                                                    curam.util.exception.InformationalException

Compares two sets of rule evidence for a product delivery and returns the differences.

Parameters:

key - The identifiers for the rules evidence being compared.

Returns:

The differences between the rule evidence.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

ProductDelivery, Decision

createActiveFixedDeduction

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.InformationMsgDtlsList createActiveFixedDeduction(curam.core.facade.struct.FixedDeductionDetails1 details)
                                                                                                 throws curam.util.exception.AppException,
                                                                                                        curam.util.exception.InformationalException

Creates and activates a fixed deduction for the product delivery.

Parameters:

details - The fixed deduction details.

Returns:

A list of informational messages.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

ProductDelivery, Deduction

Business Object Write:

Deduction

createActiveThirdPartyFixedDeduction

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.InformationMsgDtlsList createActiveThirdPartyFixedDeduction(curam.core.facade.struct.ThirdPartyFixedDeductionDetails1 details)
                                                                                                           throws curam.util.exception.AppException,
                                                                                                                  curam.util.exception.InformationalException

Creates and activates a third party deduction for a product delivery.

Parameters:

details - The third party deduction details.

Returns:

A list of informational messages.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

ProductDelivery, Deduction

Business Object Write:

Deduction

createActiveThirdPartyVariableDeduction

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.InformationMsgDtlsList createActiveThirdPartyVariableDeduction(curam.core.facade.struct.ThirdPartyVariableDeductionDetails1 details)
                                                                                                              throws curam.util.exception.AppException,
                                                                                                                     curam.util.exception.InformationalException

Creates and activates a third party variable deduction for a product delivery.

Parameters:

details - The third party variable deduction details.

Returns:

A list of informational messages.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

ProductDelivery, Deduction

Business Object Write:

Deduction

createActiveVariableDeduction

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.InformationMsgDtlsList createActiveVariableDeduction(curam.core.facade.struct.CreateDeductionDetails1 details)
                                                                                                    throws curam.util.exception.AppException,
                                                                                                           curam.util.exception.InformationalException

Creates and activates a variable deduction for a product delivery.

Parameters:

details - The variable deduction details.

Returns:

A list of informational messages.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

ProductDelivery, Deduction

Business Object Write:

Deduction

createAssessment

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.CreateAssessmentDeliveryDetails createAssessment(curam.core.facade.struct.CreateAssessmentDeliveryKey key)
                                                                                                throws curam.util.exception.AppException,
                                                                                                       curam.util.exception.InformationalException

Creates an assessment on a product delivery and assigns the owner the appropriate role.

Parameters:

key - The create assessment details.

Returns:

The identifier for the assessment that was created.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

ProductDelivery

Business Object Write:

Assessment, ProductDelivery, CaseUserRole

createCase
```
@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.CreatedCaseIDKey createCase(curam.core.facade.struct.CreateCaseDetails details)
                                                                           throws curam.util.exception.AppException,
                                                                                  curam.util.exception.InformationalException
```
Creates a product delivery and links the clients' participant evidence to it.

Parameters:

details - The details to create the product delivery.

Returns:

The identifier for the product delivery that was created.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:
Product, CaseParticipant, EvidenceDescriptor

Business Object Write:
ProductDelivery, EvidenceDescriptor, Assessment

createCertification
```
@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.InformationMsgDtlsList createCertification(curam.core.facade.struct.CreateCertificationDetails details)
                                                                                          throws curam.util.exception.AppException,
                                                                                                 curam.util.exception.InformationalException
```
Creates a certification on a product delivery. The case nominee delivery patterns, eligibility decisions and evidence attributions for the product delivery that the certification is for are updated before the product delivery is reassessed.

Parameters:

details - The details of the certification to be created.

Returns:

A list of informational messages.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:
CertificationDiary, Case, Decision

Business Object Write:
CertificationDiary, Assessment, CaseNominee, Decision

createFixedDeduction1

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.InformationMsgDtlsList createFixedDeduction1(curam.core.facade.struct.FixedDeductionDetails1 details)
                                                                                            throws curam.util.exception.AppException,
                                                                                                   curam.util.exception.InformationalException

Creates a new fixed deduction on a product delivery and fires the create deduction workflow event.

Parameters:

details - The details for the deduction.

Returns:

A list of informational messages.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

Deduction

createMilestone

@AccessLevel(value=EXTERNAL)
curam.core.sl.entity.struct.MilestoneDeliveryKey createMilestone(curam.core.sl.struct.MilestoneDeliveryDtls dtls)
                                                                                       throws curam.util.exception.AppException,
                                                                                              curam.util.exception.InformationalException

Creates a milestone for this product delivery and fires the milestone created workflow event.

Parameters:

details - The milestone details

Returns:

The unique identifier of the newly created milestone.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

Milestone, CaseEvent

createThirdPartyFixedDeduction1

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.InformationMsgDtlsList createThirdPartyFixedDeduction1(curam.core.facade.struct.ThirdPartyFixedDeductionDetails1 details)
                                                                                                      throws curam.util.exception.AppException,
                                                                                                             curam.util.exception.InformationalException

Creates a third party fixed deduction on a product delivery and fires the create deduction workflow event.

Parameters:

details - The details for the deduction.

Returns:

A list of informational messages.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

ProductDelivery

Business Object Write:

ProductDelivery, Deduction, CaseEvent

createThirdPartyVariableDeduction1

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.InformationMsgDtlsList createThirdPartyVariableDeduction1(curam.core.facade.struct.ThirdPartyVariableDeductionDetails1 details)
                                                                                                         throws curam.util.exception.AppException,
                                                                                                                curam.util.exception.InformationalException

Creates a third party variable deduction on a product delivery and fires the create deduction event.

Parameters:

details - The details for the deduction.

Returns:

A list of informational messages.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

ProductDelivery

Business Object Write:

ProductDelivery, Deduction, CaseEvent

createUtilityPayment
```
@AccessLevel(value=EXTERNAL)
void createUtilityPayment(curam.core.facade.struct.CreateUtilityPaymentDetails details)
                                                throws curam.util.exception.AppException,
                                                       curam.util.exception.InformationalException
```
Creates a utility payment on a product delivery and triggers a regeneration of the financials.

Parameters:

details - The utility payment details.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:
CaseParticipant, CaseStatus

Business Object Write:
HouseholdBudgetItem

createVariableDeduction1

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.InformationMsgDtlsList createVariableDeduction1(curam.core.facade.struct.CreateDeductionDetails1 details)
                                                                                               throws curam.util.exception.AppException,
                                                                                                      curam.util.exception.InformationalException

Creates a variable deduction on a product delivery and fires the create deduction workflow event.

Parameters:

details - The details for the deduction.

Returns:

A list of informational messages.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

ProductDelivery

Business Object Write:

ProductDelivery, Deduction, CaseEvent

deactivateDeduction
```
@AccessLevel(value=EXTERNAL)
void deactivateDeduction(curam.core.facade.struct.DeductionItemKeyVersionNo key)
                                               throws curam.util.exception.AppException,
                                                      curam.util.exception.InformationalException
```
Deactivates a deduction, records a deduction history record and then regenerates the financials. The deactivate deduction workflow event is fired.

Parameters:

key - The deduction identifier.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:
Deduction

Business Object Write:
Deduction, CaseEvent, CaseStatus

generatePayment
```
@AccessLevel(value=EXTERNAL)
void generatePayment(curam.core.facade.struct.GeneratePaymentKey key)
                                           throws curam.util.exception.AppException,
                                                  curam.util.exception.InformationalException
```
Generates a payment for a product delivery based on the status of the product delivery and the configured application properties (e.g. curam.miscapp.payuptocloseddate and curam.miscapp.payuptosuspendeddate properties). Payments are made using deferred processing based on the delivery patterns and delivery methods associated with the product delivery.

Parameters:

key - The product delivery identifier.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:
ProductDelivery, Product, CaseStatus, FinancialComponent

Business Object Write:
CaseStatus, ProductDelivery

getDeductionClient

@AccessLevel(value=EXTERNAL)
curam.core.struct.ConcernRoleID getDeductionClient(curam.core.facade.struct.DeductionClientDetails details)
                                                                         throws curam.util.exception.AppException,
                                                                                curam.util.exception.InformationalException

Returns a concern role identifier for the specified deduction client.

Parameters:

details - The details of the deduction client.

Returns:

The concern role identifier for the specified deduction client.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Deduction, ConcernRole

listActiveDecision

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListDecisionDetails listActiveDecision(curam.core.facade.struct.ListDecisionKey key)
                                                                                      throws curam.util.exception.AppException,
                                                                                             curam.util.exception.InformationalException

Returns a list of the active decisions for a product delivery.

Parameters:

key - The product delivery identifier.

Returns:

A list of the active decisions for a product delivery.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Decision

listActiveDeduction

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.DeductionList listActiveDeduction(curam.core.facade.struct.ListCaseDeductionsKey key)
                                                                                 throws curam.util.exception.AppException,
                                                                                        curam.util.exception.InformationalException

Lists the active deductions on a product delivery.

Parameters:

key - The product delivery identifier.

Returns:

A list of active deductions.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Deduction

listActiveLiabilitiesForConcern
```
@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListActiveLiabilityDetails listActiveLiabilitiesForConcern(curam.core.facade.struct.ListActiveLiabilitesForConcernKey key)
                                                                                                          throws curam.util.exception.AppException,
                                                                                                                 curam.util.exception.InformationalException
```
Returns details of all active liability cases for the specified concern role against which deductions can be applied. Note that any payment correction liabilities will not be included in this list, those have to be added separately using getActiveOverpaymentCorrectionCasesForConcern().

Parameters:

key - The concern role identifier.

Returns:

A list of the active liability cases for a concern.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:
ProductDelivery, Deduction

listAdminCaseRole

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListPDAdminCaseRoleDetails listAdminCaseRole(curam.core.facade.struct.ListAdminCaseRoleKey key)
                                                                                            throws curam.util.exception.AppException,
                                                                                                   curam.util.exception.InformationalException

Returns a list of the administrator case roles on a product delivery.

Parameters:

key - The product delivery identifier.

Returns:

A list of administrator case roles.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

CaseUserRole, ProductDelivery

listAppliedAndUnappliedDeduction

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.DeductionList listAppliedAndUnappliedDeduction(curam.core.facade.struct.ListCaseDeductionsKey key)
                                                                                              throws curam.util.exception.AppException,
                                                                                                     curam.util.exception.InformationalException

List the applied or un-applied deductions on the product delivery.

Parameters:

key - The product delivery identifier.

Returns:

A list of the applied or un-applied deductions.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

ProductDelivery, Deduction

listAppliedDeductionHistory

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.CaseAppliedDeductionHistoryDetailsList listAppliedDeductionHistory(curam.core.facade.struct.CaseDeductionHistoryListKey key)
                                                                                                                  throws curam.util.exception.AppException,
                                                                                                                         curam.util.exception.InformationalException

Lists the deduction history for an applied deduction.

Parameters:

key - The deduction identifier.

Returns:

A list of deduction history records.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Deduction

listAppliedDeductionName

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.DeductionNameList listAppliedDeductionName(curam.core.facade.struct.CaseIDKey key)
                                                                                          throws curam.util.exception.AppException,
                                                                                                 curam.util.exception.InformationalException

Lists all applied deduction names and their associated categories and priorities.

Parameters:

key - The product delivery identifier.

Returns:

A list of deduction names.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

ProductDelivery, Deduction

listAssessment

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListAssessmentForProductDelivery listAssessment(curam.core.facade.struct.CaseKey_fo key)
                                                                                               throws curam.util.exception.AppException,
                                                                                                      curam.util.exception.InformationalException

Returns a list of assessments on a product delivery.

Parameters:

key - The product delivery identifier.

Returns:

A list of assesments for a product delivery.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Assessment

listAttachment

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListAttachmentDetails listAttachment(curam.core.facade.struct.ListAttachmentsKey key)
                                                                                    throws curam.util.exception.AppException,
                                                                                           curam.util.exception.InformationalException

Returns the list of attachments on a product delivery.

Parameters:

key - The product delivery identifier.

Returns:

A list of attachments.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Attachment

listCaseFinancialInstruction

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ViewCaseFinancialInstructionList listCaseFinancialInstruction(curam.core.facade.struct.ListCaseFinancialsKey key)
                                                                                                             throws curam.util.exception.AppException,
                                                                                                                    curam.util.exception.InformationalException

List the financial instructions associated with this product delivery.

Parameters:

key - The product delivery identifier.

Returns:

A list of the financial instructions associated with this product delivery.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

ProductDelivery, FinancialComponent, FinancialInstruction, InstructionLineItem

listCasePaymentSimulations

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.SimulationsByCaseIDList listCasePaymentSimulations(curam.core.struct.CaseKey caseKey)
                                                                                                  throws curam.util.exception.AppException,
                                                                                                         curam.util.exception.InformationalException

Returns a list of the payment simulations for the product delivery.

Parameters:

caseKey - The product delivery identifier.

Returns:

A list of the payment simulations for the product delivery.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

PaymentSimulation, ProductDelivery

listClientRole

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListPDClientRoleDetails listClientRole(curam.core.facade.struct.ListClientRoleKey key)
                                                                                      throws curam.util.exception.AppException,
                                                                                             curam.util.exception.InformationalException

Returns a list of the case participant client roles on a product delivery.

Parameters:

key - The product delivery identifier.

Returns:

A list of the client roles on a product delivery.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

CaseParticipant

listDecision

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListDecisionDetails listDecision(curam.core.facade.struct.ListDecisionKey key)
                                                                                throws curam.util.exception.AppException,
                                                                                       curam.util.exception.InformationalException

Returns a list of decisions on a product delivery.

Parameters:

key - The product delivery identifier.

Returns:

A list of the product delivery decisions.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Decision, ProductDelivery

listDeductableObjectives

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListObjectiveDeductableDetails listDeductableObjectives(curam.core.facade.struct.ListDeductableObjectivesKey key)
                                                                                                       throws curam.util.exception.AppException,
                                                                                                              curam.util.exception.InformationalException

Returns a list of the objectives on the product delivery against which a deduction can be created.

Parameters:

key - The product delivery identifier.

Returns:

A list of the product delivery objectives.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Decision, ProductDelivery

listDeduction

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListDeductionDetails listDeduction(curam.core.facade.struct.ListCaseDeductionsKey key)
                                                                                  throws curam.util.exception.AppException,
                                                                                         curam.util.exception.InformationalException

Returns a list of the deductions on the product delivery.

Parameters:

key - The product delivery identifier.

Returns:

A list of the product delivery decisions.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

ProductDelivery, Deduction

listDeductionsForObjective

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListObjectiveDeductionDetails listDeductionsForObjective(curam.core.facade.struct.ListDeductionsForObjectiveKey key)
                                                                                                        throws curam.util.exception.AppException,
                                                                                                               curam.util.exception.InformationalException

Returns the list of deductions for a rules objective.

Parameters:

key - The product delivery identifier.

Returns:

A list of the product delivery deductions.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Product, Deduction, HouseholdBudgetItem

listDeliveryPatternInfoDetails

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListPDDeliveryPatternHistoryDetails_fo listDeliveryPatternInfoDetails(curam.core.sl.struct.ProductDeliveryPatternByCaseIDKey key)
                                                                                                                     throws curam.util.exception.AppException,
                                                                                                                            curam.util.exception.InformationalException

Returns a list of the delivery pattern details for a specified product delivery.

Parameters:

key - The product delivery identifier.

Returns:

A list of delivery pattern details.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

ProductDelivery, CaseNominee

listEvidence

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListPDEvidenceDetails listEvidence(curam.core.facade.struct.ListEvidenceKey key)
                                                                                  throws curam.util.exception.AppException,
                                                                                         curam.util.exception.InformationalException

List the evidence associated with the product delivery.

Parameters:

key - The product delivery identifier.

Returns:

A list of evidence details.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

ProductDelivery, EvidenceDescriptor

listEvidenceUsedByRule

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListEvidenceUsedByRuleResult listEvidenceUsedByRule(curam.core.facade.struct.ListEvidenceUsedByRuleKey key)
                                                                                                   throws curam.util.exception.AppException,
                                                                                                          curam.util.exception.InformationalException

Lists the evidence item names and values along with a legislation name and rule name for a rule.

Parameters:

key - The rule and decision identifiers.

Returns:

A list of the evidence used by a rule.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Decision, ProductDelivery

listInvestigation

@AccessLevel(value=EXTERNAL)
curam.core.sl.struct.InvestigationDeliveryDetailsList listInvestigation(curam.core.struct.CaseHeaderKey key)
                                                                                              throws curam.util.exception.AppException,
                                                                                                     curam.util.exception.InformationalException

Returns a list of the investigations related to this product delivery.

Parameters:

key - The product delivery identifier.

Returns:

A list of investigations.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

ProductDelivery, Investigation, CaseParticipant, ConcernRole

listInvestigationDeliveryCaseMembers

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ICInvestigationDeliveryClientRoleList listInvestigationDeliveryCaseMembers(curam.core.struct.CaseHeaderKey key)
                                                                                                                          throws curam.util.exception.AppException,
                                                                                                                                 curam.util.exception.InformationalException

Returns a list of the case members involved in this investigation.

Parameters:

key - The investigation identifier.

Returns:

A list of case members.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

CaseParticipant, ConcernRole

listLocation

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListLocationDetails listLocation(curam.core.facade.struct.ListLocationKey key)
                                                                                throws curam.util.exception.AppException,
                                                                                       curam.util.exception.InformationalException

Returns a list of the location details for the product delivery.

Parameters:

key - The product delivery identifier.

Returns:

A list of the location details for the product delivery.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

ProductDelivery, Product

listMilestone

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListMilestoneForProductDeliveryDetails listMilestone(curam.core.struct.CaseHeaderKey key)
                                                                                                    throws curam.util.exception.AppException,
                                                                                                           curam.util.exception.InformationalException

Returns a list of the milestone details for the product delivery.

Parameters:

key - The product delivery identifier.

Returns:

A list of the milestone details for the product delivery.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

ProductDelivery

listOutcomesForCase

@AccessLevel(value=EXTERNAL)
curam.core.sl.struct.OutcomeNameAndIDDetailsList listOutcomesForCase(curam.core.facade.struct.ListOutcomesKey key)
                                                                                           throws curam.util.exception.AppException,
                                                                                                  curam.util.exception.InformationalException

Returns a list of the expected outcomes for the product delivery.

Parameters:

key - The product delivery identifier.

Returns:

A list of expected outcomes.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

ProductDelivery, Outcome, PlannedItem

listOverUnderPayment

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListOverUnderPaymentDetails listOverUnderPayment(curam.core.facade.struct.ListOverUnderPaymentKey key)
                                                                                                throws curam.util.exception.AppException,
                                                                                                       curam.util.exception.InformationalException

Returns a list of over / under payments for a product delivery.

Parameters:

key - The product delivery identifier.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

ProductDelivery

listProductComponent

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.UtilityProductComponentList listProductComponent(curam.core.facade.struct.UtilityPaymentCaseKey key)
                                                                                                throws curam.util.exception.AppException,
                                                                                                       curam.util.exception.InformationalException

Returns a list of product components that are applicable to the specified case.

Parameters:

key - The product delivery identifier.

Returns:

A list of product components.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

ProductDelivery, Product, CaseNominee

listReassessmentPeriodDecision

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListReassessmentDecisionResult listReassessmentPeriodDecision(curam.core.facade.struct.ListDecisionsForReassessmentPeriodKey key)
                                                                                                             throws curam.util.exception.AppException,
                                                                                                                    curam.util.exception.InformationalException

Returns a list of decisions for the reassessment period.

Parameters:

key - The reassessment information idenfitier.

Returns:

A list of product components.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

ProductDelivery, Decision

listRelationship

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListRelationshipCaseDetails listRelationship(curam.core.facade.struct.ListCaseRelationshipKey key)
                                                                                            throws curam.util.exception.AppException,
                                                                                                   curam.util.exception.InformationalException

Returns a list of cases that have case relationships with the product delivery.

Parameters:

key - The product delivery identifier.

Returns:

A list of cases that have case relationships with the product delivery.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

ProductDelivery

listSortedAppliedDeductionHistory

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.CaseAppliedDeductionHistoryDetailsList1 listSortedAppliedDeductionHistory(curam.core.facade.struct.CaseDeductionHistoryListKey key)
                                                                                                                         throws curam.util.exception.AppException,
                                                                                                                                curam.util.exception.InformationalException

Returns a deduction history for an applied case deduction, sorted by effective date.

Parameters:

key - The deduction identifier.

Returns:

A sorted deduction history.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Deduction

listSortedThirdPartyDeductionHistory

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.CaseThirdPartyDeductionHistoryDetailsList1 listSortedThirdPartyDeductionHistory(curam.core.facade.struct.CaseDeductionHistoryListKey key)
                                                                                                                               throws curam.util.exception.AppException,
                                                                                                                                      curam.util.exception.InformationalException

Returns a deduction history for a third party case deduction sorted by effective date.

Parameters:

key - The deduction identifier.

Returns:

A sorted deduction history.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Deduction

listSortedUnappliedDeductionHistory

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.CaseUnappliedDeductionHistoryDetailsList1 listSortedUnappliedDeductionHistory(curam.core.facade.struct.CaseDeductionHistoryListKey key)
                                                                                                                             throws curam.util.exception.AppException,
                                                                                                                                    curam.util.exception.InformationalException

Returns a deduction history for an un-applied case deduction sorted by effective date.

Parameters:

key - The deduction identifier.

Returns:

A sorted deduction history.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Deduction

listStatusHistory1

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListProductDeliveryStatusHistoryDetails1 listStatusHistory1(curam.core.facade.struct.ListProductDeliveryStatusHistoryKey key)
                                                                                                           throws curam.util.exception.AppException,
                                                                                                                  curam.util.exception.InformationalException

Returns a case status history for a product delivery.

Parameters:

key - The product delivery identifier.

Returns:

A case status history for a product delivery.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

ProductDelivery

listThirdPartyDeduction

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.DeductionList listThirdPartyDeduction(curam.core.facade.struct.ListCaseDeductionsKey key)
                                                                                     throws curam.util.exception.AppException,
                                                                                            curam.util.exception.InformationalException

Returns a list of all third party case deductions.

Parameters:

key - The deduction identifier.

Returns:

A list of the third party case deductions on the product delivery.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Deduction

listThirdPartyDeductionHistory

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.CaseThirdPartyDeductionHistoryDetailsList listThirdPartyDeductionHistory(curam.core.facade.struct.CaseDeductionHistoryListKey key)
                                                                                                                        throws curam.util.exception.AppException,
                                                                                                                               curam.util.exception.InformationalException

Returns a deduction history for a third party case deduction.

Parameters:

key - The deduction identifier.

Returns:

A deduction history for a third party case deduction.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Deduction

listThirdPartyDeductionName

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.DeductionNameList listThirdPartyDeductionName(curam.core.facade.struct.CaseIDKey key)
                                                                                             throws curam.util.exception.AppException,
                                                                                                    curam.util.exception.InformationalException

Returns a list of all third party deduction names and their associated categories and priorities for a product delivery.

Parameters:

key - The product delivery identifier.

Returns:

A list of third party deduction names.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

ProductDelivery, Deduction

listUnappliedDeductionHistory

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.CaseUnappliedDeductionHistoryDetailsList listUnappliedDeductionHistory(curam.core.facade.struct.CaseDeductionHistoryListKey key)
                                                                                                                      throws curam.util.exception.AppException,
                                                                                                                             curam.util.exception.InformationalException

Returns a deduction history for an un-applied case deduction.

Parameters:

key - The deduction identifier.

Returns:

A deduction history for an un-applied case deduction.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Deduction

listUnappliedDeductionName

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.DeductionNameList listUnappliedDeductionName(curam.core.facade.struct.CaseIDKey key)
                                                                                            throws curam.util.exception.AppException,
                                                                                                   curam.util.exception.InformationalException

Returns a list of all un-applied deduction names and their associated categories and priorities for a product delivery.

Parameters:

key - The product delivery identifier.

Returns:

A list of un-applied deduction names.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

ProductDelivery, Deduction

listUncompletedMilestone

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListMilestoneForProductDeliveryDetails listUncompletedMilestone(curam.core.struct.CaseHeaderKey key)
                                                                                                               throws curam.util.exception.AppException,
                                                                                                                      curam.util.exception.InformationalException

Returns a list of milestones for the product delivery which have a status of 'not started' or 'in progress'.

Parameters:

key - The product delivery identifier.

Returns:

A list of uncompleted milestones

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

ProductDelivery, Milestone

listUnprocessedILIs

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.UnprocessedILIDetailsList listUnprocessedILIs(curam.core.struct.SearchUnprocessedByCaseIDKey searchUnprocessedKey)
                                                                                             throws curam.util.exception.AppException,
                                                                                                    curam.util.exception.InformationalException

Returns a list of the unprocessed ILIs (Instruction Line Items) for the product delivery.

Parameters:

key - The product delivery identifier and status code to represent an unprocessed line item.

Returns:

A list of instruction line items.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

ProductDelivery, ConcernRole, CaseNominee, InstructionLineItem

listUtilityPayment

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListUtilityPayments listUtilityPayment(curam.core.facade.struct.ListUtilityPaymentKey key)
                                                                                      throws curam.util.exception.AppException,
                                                                                             curam.util.exception.InformationalException

Returns a list of the utility payments made to a concern role.

Parameters:

key - The product delivery identifier.

Returns:

A list of utility payments.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

HouseholdBudgetItem, ProductDelivery, Utility

modifyCaseDeductionItem1

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.InformationMsgDtlsList modifyCaseDeductionItem1(curam.core.facade.struct.ModifyCaseDeductionItemDetails1 details)
                                                                                               throws curam.util.exception.AppException,
                                                                                                      curam.util.exception.InformationalException

Modifies the details for a case deduction.

Parameters:

details - The modified deduction details.

Returns:

A list of informational messages.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Deduction

Business Object Write:

Deduction

modifyCertification

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.InformationMsgDtlsList modifyCertification(curam.core.facade.struct.MaintainCertificationDetails details)
                                                                                          throws curam.util.exception.AppException,
                                                                                                 curam.util.exception.InformationalException

Modifies the certification details for a product delivery case.

Parameters:

details - The modified certification diary details.

Returns:

A list of informational messages.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

CertificationDiary

Business Object Write:

CertificationDiary

modifyCertificationFrequency

@AccessLevel(value=EXTERNAL)
void modifyCertificationFrequency(curam.core.facade.struct.ModifyCertificationFrequencyDetails details)
                                                        throws curam.util.exception.AppException,
                                                               curam.util.exception.InformationalException

Modifies the certification frequency on a product delivery.

Parameters:

details - The modified certification frequency details.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

CertificationDiary, Product

Business Object Write:

CertificationDiary, Product

modifyClosureDetails

@AccessLevel(value=EXTERNAL)
void modifyClosureDetails(curam.core.facade.struct.ClosureDetails details,
                                                       curam.core.facade.struct.ModifyClosureDetailsKey key)
                                                throws curam.util.exception.AppException,
                                                       curam.util.exception.InformationalException

Modifies the closure details for a product delivery case.

Parameters:

details - The new certification frequency details.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

ProductDelivery, CaseStatus

Business Object Write:

CaseStatus, Assessment, CaseEvent, CertificationDiary

modifyDeductionItem

@AccessLevel(value=EXTERNAL)
void modifyDeductionItem(curam.core.struct.MaintainDeductionItemDetails details)
                                               throws curam.util.exception.AppException,
                                                      curam.util.exception.InformationalException

Modifies the deduction details.

Parameters:

details - The modified deduction details.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

ConcernRole, Deduction

Business Object Write:

Deduction

modifyDeliveryPattern

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.InformationMsgDtlsList modifyDeliveryPattern(curam.core.facade.struct.ModifyDeliveryPatternDetails details)
                                                                                            throws curam.util.exception.AppException,
                                                                                                   curam.util.exception.InformationalException

Modifies the delivery pattern details for a product delivery.

Parameters:

details - The modified delivery pattern details.

Returns:

A list of informational messages.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

CaseNominee, Assessment, CaseStatus, ProductDeliveryPattern

Business Object Write:

ProductDelivery, ProductDeliveryPattern

modifyHeader

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.InformationMsgDtlsList modifyHeader(curam.core.facade.struct.ModifyHeaderDetails details)
                                                                                   throws curam.util.exception.AppException,
                                                                                          curam.util.exception.InformationalException

Modifies the details of a product delivery header.

Parameters:

details - The modified delivery pattern header details.

Returns:

A list of informational messages.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

CaseParticipant, ProductDelivery

Business Object Write:

CaseParticipant, ProductDelivery

modifyLocation

@AccessLevel(value=EXTERNAL)
void modifyLocation(curam.core.facade.struct.ProductDeliveryModifyLocationDetails details)
                                          throws curam.util.exception.AppException,
                                                 curam.util.exception.InformationalException

Modifies the location details for a product delivery.

Parameters:

details - The modified location details.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

ProductDelivery

Business Object Write:

ProductDelivery

modifyMilestone
```
@AccessLevel(value=EXTERNAL)
void modifyMilestone(curam.core.sl.struct.MilestoneDeliveryDtls dtls)
                                           throws curam.util.exception.AppException,
                                                  curam.util.exception.InformationalException
```
Modifies the milestone details for a product delivery.

Parameters:

details - The modified milestone details.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:
ProductDelivery, Milestone

Business Object Write:
Milestone, ProductDelivery, CaseEvent

modifyMilestoneForWaiver
```
@AccessLevel(value=EXTERNAL)
void modifyMilestoneForWaiver(curam.core.sl.struct.MilestoneDeliveryDtls details)
                                                    throws curam.util.exception.AppException,
                                                           curam.util.exception.InformationalException
```
Modifies the product delivery milestone details for a milestone waiver.

Parameters:

details - The modified milestone details.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:
ProductDelivery, Milestone

Business Object Write:
Milestone, ProductDelivery, CaseEvent

modifyThirdPartyDeductionItem

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.InformationMsgDtlsList modifyThirdPartyDeductionItem(curam.core.facade.struct.ModifyThirdPartyDeductionDetails details)
                                                                                                    throws curam.util.exception.AppException,
                                                                                                           curam.util.exception.InformationalException

Modifies details for a third party case deduction.

Parameters:

details - The modified deduction details.

Returns:

A list of informational messages.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

ConcernRole, Deduction

Business Object Write:

Deduction

reactivate
```
@AccessLevel(value=EXTERNAL)
void reactivate(curam.core.facade.struct.ReactivationDetails details)
                                      throws curam.util.exception.AppException,
                                             curam.util.exception.InformationalException
```
Reopens a Product Delivery case with status as either Closed or Pending Closure.

Parameters:

details - The reactivation details.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:
ProductDelivery, CaseEvent, ConcernRole, Communication, Product

readCertification

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadCertificationDetails readCertification(curam.core.facade.struct.MaintainCertificationKey key)
                                                                                          throws curam.util.exception.AppException,
                                                                                                 curam.util.exception.InformationalException

Reads the certification details for a product delivery.

Parameters:

key - The certification diary identifier.

Returns:

The certification details.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

CertificationDiary

readCertificationFrequency

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.CertificationFrequencyDetails readCertificationFrequency(curam.core.facade.struct.ReadProductDeliveryFreqKey key)
                                                                                                        throws curam.util.exception.AppException,
                                                                                                               curam.util.exception.InformationalException

Reads the certification frequency of a product delivery.

Parameters:

key - The product delivery identifier.

Returns:

The certification details of the product delivery.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

CertificationDiary, Product

readClosureDetails

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ClosureDetails readClosureDetails(curam.core.facade.struct.ReadCaseClosureKey key)
                                                                                 throws curam.util.exception.AppException,
                                                                                        curam.util.exception.InformationalException

Reads the closure details for a product delivery.

Parameters:

key - The product delivery identifier.

Returns:

The closure details for the product delivery.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

CaseStatus, CaseNote, CaseEvent, ProductDelivery

readDecision

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadCaseDecisionDetails readDecision(curam.core.facade.struct.ReadCaseDecisionKey key)
                                                                                    throws curam.util.exception.AppException,
                                                                                           curam.util.exception.InformationalException

Read a case decision for a product delivery.

Parameters:

The - decision identifier.

Returns:

The case decision details.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Decision

readDeduction1

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadDeductionAndHeaderDetails readDeduction1(curam.core.facade.struct.ReadDeductionKey key)
                                                                                            throws curam.util.exception.AppException,
                                                                                                   curam.util.exception.InformationalException

Reads the details of an applied deduction.

Parameters:

The - deduction identifier.

Returns:

The details for the deduction.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

ConcernRole, CaseNominee, Deduction, ProductDelivery

readDeductionCategory

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.DeductionCategory readDeductionCategory(curam.core.facade.struct.ReadDeductionKey key)
                                                                                       throws curam.util.exception.AppException,
                                                                                              curam.util.exception.InformationalException

Reads the category for a case deduction.

Parameters:

The - deduction identifier.

Returns:

The category details for the deduction.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Deduction

readDeductionLiabilityDetails

@AccessLevel(value=EXTERNAL)
curam.core.struct.DeductionHeaderDetails readDeductionLiabilityDetails(curam.core.sl.struct.CaseIDKey key)
                                                                                             throws curam.util.exception.AppException,
                                                                                                    curam.util.exception.InformationalException

Reads the deduction details to be displayed on the create deduction details page.

Parameters:

The - product delivery identifier.

Returns:

The deduction details.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

ConcernRole, ProductDelivery

readDefaultDeductionDetails

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.DefaultDeductionDetails readDefaultDeductionDetails(curam.core.facade.struct.DefaultDeductionKey key)
                                                                                                   throws curam.util.exception.AppException,
                                                                                                          curam.util.exception.InformationalException

Reads the initial data for the creation of applied, fixed and variable deductions.

Parameters:

The - deduction identifier.

Returns:

The deduction details.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Deduction, ConcernRole

readLastPaymentDate

@AccessLevel(value=EXTERNAL)
curam.core.struct.InformationalMsgDtlsList readLastPaymentDate(curam.core.facade.struct.CaseIDKey key)
                                                                                     throws curam.util.exception.AppException,
                                                                                            curam.util.exception.InformationalException

Reads the last payment date for a product delivery.

Parameters:

The - product delivery identifier.

Returns:

A list of informational messages.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

FinancialComponent, ProductDelivery, InstructionLineItem

readMilestone

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadMilestoneDeliveryDetails readMilestone(curam.core.sl.entity.struct.MilestoneDeliveryKey key)
                                                                                          throws curam.util.exception.AppException,
                                                                                                 curam.util.exception.InformationalException

Reads the milestone details for a product delivery milestone.

Parameters:

The - milestone identifier.

Returns:

The milestone details.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Milestone

readOverUnderPayment

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadOverUnderPaymentDetails readOverUnderPayment(curam.core.facade.struct.ReadOverUnderPaymentDetailsKey key)
                                                                                                throws curam.util.exception.AppException,
                                                                                                       curam.util.exception.InformationalException

Reads the over/under payment details.

Parameters:

key - The product delivery and the over/under payment identifiers.

Returns:

The over/under payment details.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Product, ProductDelivery

readProductID

@AccessLevel(value=EXTERNAL)
curam.core.struct.ProductIDDetails readProductID(curam.core.sl.struct.CaseIDKey key)
                                                                       throws curam.util.exception.AppException,
                                                                              curam.util.exception.InformationalException

Reads the product identifier for a product delivery.

Parameters:

The - product delivery identifier.

Returns:

The product identifier for the product delivery.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

ProductDelivery

readProductType

@AccessLevel(value=EXTERNAL)
curam.core.struct.ProductDeliveryTypeDetails readProductType(curam.core.struct.ProductDeliveryKey productDeliveryKey)
                                                                                   throws curam.util.exception.AppException,
                                                                                          curam.util.exception.InformationalException

Reads the product type for a product delivery.

Parameters:

The - product delivery idetifier.

Returns:

The product type for the product delivery.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

ProductDelivery

readRelatedCaseID

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.RelatedCaseID readRelatedCaseID(curam.core.facade.struct.ReadDeductionKey key)
                                                                               throws curam.util.exception.AppException,
                                                                                      curam.util.exception.InformationalException

Reads the related case identifier for a deduction.

Parameters:

The - deduction identifier.

Returns:

The related case identifier.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

ProductDelivery

readRelatedCaseIDAndThirdPartyID

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.RelatedCaseIDThirdPartyID readRelatedCaseIDAndThirdPartyID(curam.core.facade.struct.ReadDeductionKey key)
                                                                                                          throws curam.util.exception.AppException,
                                                                                                                 curam.util.exception.InformationalException

Reads the related case identifier and the third party concern role identifier for a case deduction.

Parameters:

The - deduction identifier.

Returns:

The related case identifier and the third party concern role identifier.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

ProductDelivery, Deduction

readSimulationDetails

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadPaymentSimulationDetails readSimulationDetails(curam.core.struct.SimulationHeaderKey key)
                                                                                                  throws curam.util.exception.AppException,
                                                                                                         curam.util.exception.InformationalException

Returns the details of a payment simulation.

Parameters:

key - The payment simulation identifier.

Returns:

The payment simulation details.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

PaymentSimulation, ConcernRole

readStatusHistory

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.CaseStatusDetails readStatusHistory(curam.core.facade.struct.CaseStatusKey key)
                                                                                   throws curam.util.exception.AppException,
                                                                                          curam.util.exception.InformationalException

Reads the product delivery status history.

Parameters:

The - product delivery identifier.

Returns:

The product delivery status history.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

CaseStatus, ProductDelivery

reassessBenefit

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReassessBenefitDetails reassessBenefit(curam.core.facade.struct.ReassessBenefitKey key)
                                                                                      throws curam.util.exception.AppException,
                                                                                             curam.util.exception.InformationalException

Reassesses a benefit product delivery.

Parameters:

key - The product delivery identifier.

Returns:

The reassessed benefits details.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

ProductDelivery, Assessment

Business Object Write:

CaseStatus, CaseEvent

reassessLiability

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReassessLiabilityDetails reassessLiability(curam.core.facade.struct.ReassessLiabilityKey key)
                                                                                          throws curam.util.exception.AppException,
                                                                                                 curam.util.exception.InformationalException

Reassesses a liability case.

Parameters:

key - The product delivery identifier.

Returns:

The return details for the reassessment.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

ProductDelivery, Assessment

Business Object Write:

CaseStatus, CaseEvent

removeAllSimulations

@AccessLevel(value=EXTERNAL)
void removeAllSimulations(curam.core.struct.CaseKey caseKey)
                                                throws curam.util.exception.AppException,
                                                       curam.util.exception.InformationalException

Remove all of the saved payment simulations for a product delivery.

Parameters:

The - product delivery identifier.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

PaymentSimulation

removeSimulation

@AccessLevel(value=EXTERNAL)
void removeSimulation(curam.core.struct.SimulationHeaderID key)
                                            throws curam.util.exception.AppException,
                                                   curam.util.exception.InformationalException

Removes a saved payment simulation.

Parameters:

key - The payment simulation identifier.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

PaymentSimulation

saveOrSimulatePayment

@AccessLevel(value=EXTERNAL)
curam.core.struct.SimulatePaymentResult1 saveOrSimulatePayment(curam.core.facade.struct.SimulationDetails details)
                                                                                     throws curam.util.exception.AppException,
                                                                                            curam.util.exception.InformationalException

Either saves or simulates a payment based on the action selected on the client.

Parameters:

details - The details for the simulation.

Returns:

The from details the simulation.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

ProductDelivery

Business Object Write:

PaymentSimulation

saveSimulationDetails1

@AccessLevel(value=EXTERNAL)
void saveSimulationDetails1(curam.core.facade.struct.SimulationDetails details)
                                                  throws curam.util.exception.AppException,
                                                         curam.util.exception.InformationalException

Saves the details of the simulation.

Parameters:

details - The simulation details.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

PaymentSimulation

setOverrideMDRInd

@AccessLevel(value=EXTERNAL)
void setOverrideMDRInd(curam.core.struct.ProductDeliveryKey key,
                                                    curam.core.struct.CuramInd details)
                                             throws curam.util.exception.AppException,
                                                    curam.util.exception.InformationalException

Sets the override max deduction rate indicator for a product delivery to true.

Parameters:

key - The product delivery identifier.

details - The value to set the override max deduction rate indicator to.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

ProductDelivery

simulatePayment1

@AccessLevel(value=EXTERNAL)
curam.core.struct.SimulatePaymentResult1 simulatePayment1(curam.core.facade.struct.SimulationDetails details)
                                                                                throws curam.util.exception.AppException,
                                                                                       curam.util.exception.InformationalException

Simulate a payment on a particular product delivery for the given date. Deprecate simulatePayment().

Parameters:

details - The payment details to simulate.

Returns:

The results of the simulation.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

ProductDelivery

Business Object Write:

PaymentSimulation

submit

@AccessLevel(value=EXTERNAL)
curam.core.struct.ApprovalMessageList submit(curam.core.facade.struct.SubmitForApprovalKey key)
                                                                   throws curam.util.exception.AppException,
                                                                          curam.util.exception.InformationalException

Submits a product delivery for approval.

Parameters:

The - product delivery identifier.

Returns:

An informational to inform the user that the product delivery has been submitted.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

ProductDelivery, CaseEvent, CaseStatus

suspend

@AccessLevel(value=EXTERNAL)
void suspend(curam.core.facade.struct.ProductDeliverySuspensionKey key)
                                   throws curam.util.exception.AppException,
                                          curam.util.exception.InformationalException

Suspends a product delivery.

Parameters:

The - product delivery identifier.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

ProductDelivery, CaseEvent, CaseStatus

unsetOverrideMDRInd

@AccessLevel(value=EXTERNAL)
void unsetOverrideMDRInd(curam.core.struct.ProductDeliveryKey key,
                                                      curam.core.struct.CuramInd details)
                                               throws curam.util.exception.AppException,
                                                      curam.util.exception.InformationalException

Unsets the override max deduction rate indicator for a product delivery by modifying it to false.

Parameters:

key - The product delivery identifier.

details - The value to set the override max deduction rate indicator to.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

ProductDelivery

unsuspend

@AccessLevel(value=EXTERNAL)
void unsuspend(curam.core.facade.struct.ProductDeliveryUnsuspensionKey key)
                                     throws curam.util.exception.AppException,
                                            curam.util.exception.InformationalException

Unsuspend a product delivery and set the status to 'open'.

Parameters:

The - product delivery identifier.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

ProductDelivery, CaseEvent, CaseStatus

userActionFixedDeduction

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.InformationMsgDtlsList userActionFixedDeduction(curam.core.facade.struct.DeductionActivationDetails details)
                                                                                               throws curam.util.exception.AppException,
                                                                                                      curam.util.exception.InformationalException

Save and activate or just save a fixed deduction based on the action selected on the client.

Parameters:

details - The details for the deduction

Returns:

A list of informational messages.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Deduction

Business Object Write:

Deduction

userActionVariableDeduction

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.InformationMsgDtlsList userActionVariableDeduction(curam.core.facade.struct.DeductionActivationDetails details)
                                                                                                  throws curam.util.exception.AppException,
                                                                                                         curam.util.exception.InformationalException

Saves and activates or just saves a variable deduction based on the action selected on the client.

Parameters:

details - The details for the deduction.

Returns:

A list of informational messages.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Deduction

Business Object Write:

Deduction

viewApprovalRequest

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.PDApprovalRequestDetails viewApprovalRequest(curam.core.facade.struct.PDApprovalRequestKey pdApprovalRequestIDKey)
                                                                                            throws curam.util.exception.AppException,
                                                                                                   curam.util.exception.InformationalException

Reads details of a product delivery approval request.

Parameters:

key - The product delivery identifier.

Returns:

The product delivery approval request details.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

ProductDelivery

getBenefitOverpaymentEvidence

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.BenefitOverpaymentEvidenceResult getBenefitOverpaymentEvidence(curam.core.struct.CaseHeaderKey key)
                                                                                                              throws curam.util.exception.AppException,
                                                                                                                     curam.util.exception.InformationalException

Returns the benefit overpayment evidence details.

Parameters:

key - The product delivery identifier.

Returns:

The evidence details for a benefit overpayment.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Assessment, ConcernRole, EvidenceDescriptor

listOverUnderPaymentBreakdown

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.OverUnderPaymentBreakdownDetailsList listOverUnderPaymentBreakdown(curam.core.facade.struct.ReadOverUnderPaymentDetailsKey key)
                                                                                                                  throws curam.util.exception.AppException,
                                                                                                                         curam.util.exception.InformationalException

Returns a list of reassessment results broken down by component.

Parameters:

key - The porduct delivery identifier.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

ProductDelivery

listBenefitStatementDetails

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.BenefitStatementDetailsList listBenefitStatementDetails(curam.core.facade.struct.BenefitStatementKey key)
                                                                                                       throws curam.util.exception.AppException,
                                                                                                              curam.util.exception.InformationalException

Returns a list of details to be displayed on the benefit statement. Called during processing when a user views the results of a case reassessment.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

compareChangedEvidenceOnly

@AccessLevel(value=EXTERNAL)
curam.core.struct.DecisionDifferenceDetails compareChangedEvidenceOnly(curam.core.facade.struct.CompareDecisionEvidenceKey key)
                                                                                             throws curam.util.exception.AppException,
                                                                                                    curam.util.exception.InformationalException

Compares two sets of decision evidence for a product delivery and returns the differences.

Parameters:

key - The identifiers for the decisions being compared.

Returns:

The differences between the decisions.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

ProductDelivery, Decision

listCurrentDeliveryPattern

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListPDDeliveryPatternHistoryDetails_fo listCurrentDeliveryPattern(curam.core.sl.struct.ProductDeliveryPatternByCaseIDKey key)
                                                                                                                 throws curam.util.exception.AppException,
                                                                                                                        curam.util.exception.InformationalException

Returns a list of delivery pattern details for the specified product delivery.

Parameters:

key - The product delivery identifier.

Returns:

A list of delivery pattern details.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

CaseNominee, ProductDelivery

listReassessmentResults

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReassessmentResultDetailsList listReassessmentResults(curam.core.facade.struct.ListOverUnderPaymentKey key)
                                                                                                     throws curam.util.exception.AppException,
                                                                                                            curam.util.exception.InformationalException

Returns the list of reassessment results for a specified product delivery.

Parameters:

key - The reassessment information idenfitier.

Returns:

A list of reassessment results.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

ProductDelivery, Decision

reassessCaseDetermination

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReassessCreoleDetails reassessCaseDetermination(curam.core.facade.struct.ReassessCreoleKey key)
                                                                                               throws curam.util.exception.AppException,
                                                                                                      curam.util.exception.InformationalException

Reassesses the case determination on the product delivery.

Parameters:

key - The product delivery identifier.

Returns:

The return details for the reassessment.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

ProductDelivery, Assessment

Business Object Write:

CaseStatus, CaseEvent

readHeader1

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadHeaderResult readHeader1(curam.core.facade.struct.ReadHeaderKey key)
                                                                            throws curam.util.exception.AppException,
                                                                                   curam.util.exception.InformationalException

Reads details of the product delivery header.

Parameters:

The - product delivery identifier.

Returns:

The product delivery header details.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

ProductDelivery, ProviderLocation

readCaseEventInvitedAttendeeParticipants

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ActivityAttendeeTypeDescList readCaseEventInvitedAttendeeParticipants()
                                                                                                                     throws curam.util.exception.AppException,
                                                                                                                            curam.util.exception.InformationalException

Reads the application property to see which participant types the user can search on when inviting an attendee to an activity.

Returns:

A list of participant types.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

CaseParticipant

listEvent1

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListEventDetails1 listEvent1(curam.core.facade.struct.ListEventKey key)
                                                                            throws curam.util.exception.AppException,
                                                                                   curam.util.exception.InformationalException

Returns a list of the events on a product delivery. Also returns display indicators used to display the appropriate list menu actions.

Parameters:

key - The product delivery identifier.

Returns:

A list of events.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

ProductDelivery, Decision, CaseEvent, Activity

readLiabilityOverbillingHomePageDetails1

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.LiabilityOverbillingHomePageDetails1 readLiabilityOverbillingHomePageDetails1(curam.core.facade.struct.ReadHomePageKey key)
                                                                                                                             throws curam.util.exception.AppException,
                                                                                                                                    curam.util.exception.InformationalException

Reads the home page details for a liability overbilling product delivery.

Parameters:

The - product delivery identifier.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

ProductDelivery, CaseEvent, CaseUserRole, CaseNominee, Assessment, Product

Business Object Write:

UserRecentAction

readHomePageDetails1

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadHomePageDetails1 readHomePageDetails1(curam.core.facade.struct.ReadHomePageKey key)
                                                                                         throws curam.util.exception.AppException,
                                                                                                curam.util.exception.InformationalException

Reads the details to populate a product delivery home page.

Parameters:

The - product delivery identifier.

Returns:

The details for the product delivery home page.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

ProductLocation, ProductDelivery

readBenefitUnderpmtHomePageDetails1

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.BenefitUnderpmtHomePageDetails1 readBenefitUnderpmtHomePageDetails1(curam.core.facade.struct.ReadHomePageKey key)
                                                                                                                   throws curam.util.exception.AppException,
                                                                                                                          curam.util.exception.InformationalException

Reads the details required to populate the benefit underpayment home page.

Parameters:

key - The product delivery identifier.

Returns:

The details for the benefit underpayment home page.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Product, CaseStatus, ProviderLocation, ProductDelivery

listSingleReassessmentPeriodDecision

@AccessLevel(value=EXTERNAL)
curam.core.struct.FilteredReassessmentDecisionsDetails listSingleReassessmentPeriodDecision(curam.core.facade.struct.ListDecisionsForReassessmentPeriodKey key)
                                                                                                                  throws curam.util.exception.AppException,
                                                                                                                         curam.util.exception.InformationalException

Returns the relevant pair of decisions for the given reassessment period or NULL if more than one pair is found.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listFilteredDecisionsForReassessmentPeriod

@AccessLevel(value=EXTERNAL)
curam.core.struct.FilteredReassessmentDecisionsDetailsList listFilteredDecisionsForReassessmentPeriod(curam.core.struct.ReassessmentInfoKey key)
                                                                                                                            throws curam.util.exception.AppException,
                                                                                                                                   curam.util.exception.InformationalException

Lists the decision pairs, based on the given reassessment information identifier. Only decision pairs which are different will be returned.

Parameters:

key - The reassessment information identifier.

Returns:

A filtered list of decisions.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Decision

listCertification1

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListCertificationDetails1 listCertification1(curam.core.facade.struct.CertificationCaseIDKey key)
                                                                                            throws curam.util.exception.AppException,
                                                                                                   curam.util.exception.InformationalException

Returns a list of the certifications for a product delivery.

Parameters:

key - The product delivery identifier.

Returns:

A list of certifications.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

ProductDelivery, CertificationDiary

reject1

@AccessLevel(value=EXTERNAL)
void reject1(curam.core.facade.struct.RejectCaseKey_fo1 key)
                                   throws curam.util.exception.AppException,
                                          curam.util.exception.InformationalException

Rejects a product delivery.

Parameters:

key - The product delivery identifier.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

CaseStatus, ProductDelivery, CaseEvent

benefitStatementBreakdownExists
```
@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.BenefitStatementDetailsList benefitStatementBreakdownExists(curam.core.facade.struct.BenefitStatementKey key)
                                                                                                           throws curam.util.exception.AppException,
                                                                                                                  curam.util.exception.InformationalException
```
Determine whether a summarized statement of the over/under payment details in the form of breakdown information is available for the benefit statement when viewing the reassessment details.

Parameters:

key - The identifiers for the reassessed product delivery, the nominee over/under payment and the reassessment information records.

Returns:

A list of benefit statement details.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:
BreakdownInformation

listBenefitStatementDetailsNoBreakdown
```
@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.BenefitStatementDetailsList listBenefitStatementDetailsNoBreakdown(curam.core.facade.struct.BenefitStatementKey key)
                                                                                                                  throws curam.util.exception.AppException,
                                                                                                                         curam.util.exception.InformationalException
```
Displays a list of reassessment details to be displayed on a statement page where there is no breakdown information available for that benefit statement. The reassessment details are retrieved from the reassessment balance information stored for the product delivery.

Parameters:

key - The product delivery identifier and the nominee over/under payment identifiers.

Returns:

The benefit statement details.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:
ProductDelivery, Product, Deduction

createNomineeRepresentativeWithTextBankAccountSortCode

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.RepresentativeID createNomineeRepresentativeWithTextBankAccountSortCode(curam.core.facade.struct.RepresentativeRegistrationWithTextBankAccountSortCodeDetails dtls)
                                                                                                                       throws curam.util.exception.AppException,
                                                                                                                              curam.util.exception.InformationalException

Creates a representative of type nominee. The bank account sort code is also returned in a text format.

Parameters:

details - The case nominee details

Returns:

The identifier for the newly created representative

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

ConcernRole

Business Object Write:

Representative, CaseNominee

listNote1

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListNoteDetails1 listNote1(curam.core.facade.struct.ListNoteKey key)
                                                                          throws curam.util.exception.AppException,
                                                                                 curam.util.exception.InformationalException

Returns a list of the notes on a product delivery.

Parameters:

key - The product delivery identifier.

Returns:

A list of the notes on the product delivery.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

ProductDelivery, Note

readAppliedDeductionParticipantsWithoutProspect

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ParticipantWithoutProspectTypeDescList readAppliedDeductionParticipantsWithoutProspect()
                                                                                                                                      throws curam.util.exception.AppException,
                                                                                                                                             curam.util.exception.InformationalException

Returns a list of the participant types the user can search on when creating an applied deduction. The list is based on the values in an application property. Prospects are filtered out of the list.

Returns:

A list of participant types.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

CaseParticipant

readThirdPartyDeductionParticipantsWithoutProspect

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ParticipantWithoutProspectTypeDescList readThirdPartyDeductionParticipantsWithoutProspect()
                                                                                                                                         throws curam.util.exception.AppException,
                                                                                                                                                curam.util.exception.InformationalException

Reads an application property to see which participant types the user can search on when they are creating a third party deduction.

Returns:

A list of participant types.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

CaseParticipant

listActiveLiabilitiesForConcernRole

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListActiveLiabilityDetails1 listActiveLiabilitiesForConcernRole(curam.core.facade.struct.ListActiveLiabilitesForConcernKeyStruct key)
                                                                                                               throws curam.util.exception.AppException,
                                                                                                                      curam.util.exception.InformationalException

Returns a list of the active liabilities for a concern with the original amount and balance outstanding for each liability. This method replaces the deprecated listActiveLiabilitiesForConcernRole() method.

Parameters:

key - The concern role identifier.

Returns:

A list of active liabilites for a concern.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

ProductDelivery, Deduction, ConcernRole

processThirdPartyFixedDeduction

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.InformationMsgDtlsList processThirdPartyFixedDeduction(curam.core.facade.struct.ThirdPartyDeductionActivationStruct details)
                                                                                                      throws curam.util.exception.AppException,
                                                                                                             curam.util.exception.InformationalException

Saves and activates or just saves a third party fixed deduction based on the value of the indicator passed in.

Parameters:

details - The deduction details and an indicator to specifiy if the deduction should be activated as well as saved.

Returns:

A list of informational messages.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

ConcernRole

Business Object Write:

Deduction, ProductDelivery

processThirdPartyVariableDeduction

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.InformationMsgDtlsList processThirdPartyVariableDeduction(curam.core.facade.struct.ThirdPartyDeductionActivationStruct details)
                                                                                                         throws curam.util.exception.AppException,
                                                                                                                curam.util.exception.InformationalException

Saves and activates or just saves a third party variable deduction based on the value of the indicator passed in.

Parameters:

details - The deduction details and an indicator to specifiy if the deduction should be activated as well as saved.

Returns:

A list of informational messages.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

ConcernRole

Business Object Write:

Deduction, ProductDelivery

getDefaultAmountForDeduction

curam.core.facade.struct.ReadDeductionAmount getDefaultAmountForDeduction(curam.core.facade.struct.ReadFinInstructionIDAndDeductionDetails readFinInstructionIDAndDeductionDetails)
                                                                   throws curam.util.exception.AppException,
                                                                          curam.util.exception.InformationalException

Returns the default deduction amount.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

readDeductionPaymentDetails

@AccessLevel(value=EXTERNAL)
curam.core.struct.InformationalMsgDtlsList readDeductionPaymentDetails(curam.core.facade.struct.ReadFinInstructionIDAndDeductionDetails readFinInstructionIDAndDeductionDetails)
                                                                                             throws curam.util.exception.AppException,
                                                                                                    curam.util.exception.InformationalException

Reads the deduction payment for a product delivery.

Parameters:

The - financial Instruction ID and deduction details.

Returns:

A list of informational messages.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

FinancialComponent, ProductDelivery, InstructionLineItem

Interface ProductDelivery

Method Summary

Method Detail

activate

activateDeduction

approve

cancelCertification

cancelDeduction

cancelMilestone

checkEligibility

checkEligibilityCaseDetermination

close

compareDecisionEvidence

compareRuleEvidence

createActiveFixedDeduction

createActiveThirdPartyFixedDeduction

createActiveThirdPartyVariableDeduction

createActiveVariableDeduction

createAssessment

createCase

createCertification

createFixedDeduction1

createMilestone

createThirdPartyFixedDeduction1

createThirdPartyVariableDeduction1

createUtilityPayment

createVariableDeduction1

deactivateDeduction

generatePayment

getDeductionClient

listActiveDecision

listActiveDeduction

listActiveLiabilitiesForConcern

listAdminCaseRole

listAppliedAndUnappliedDeduction

listAppliedDeductionHistory

listAppliedDeductionName

listAssessment

listAttachment

listCaseFinancialInstruction

listCasePaymentSimulations

listClientRole

listDecision

listDeductableObjectives

listDeduction

listDeductionsForObjective

listDeliveryPatternInfoDetails

listEvidence

listEvidenceUsedByRule

listInvestigation

listInvestigationDeliveryCaseMembers

listLocation

listMilestone

listOutcomesForCase

listOverUnderPayment

listProductComponent

listReassessmentPeriodDecision

listRelationship

listSortedAppliedDeductionHistory

listSortedThirdPartyDeductionHistory

listSortedUnappliedDeductionHistory

listStatusHistory1

listThirdPartyDeduction

listThirdPartyDeductionHistory

listThirdPartyDeductionName

listUnappliedDeductionHistory

listUnappliedDeductionName

listUncompletedMilestone

listUnprocessedILIs

listUtilityPayment

modifyCaseDeductionItem1

modifyCertification

modifyCertificationFrequency

modifyClosureDetails

modifyDeductionItem

modifyDeliveryPattern

modifyHeader

modifyLocation

modifyMilestone

modifyMilestoneForWaiver