IntegratedCase (core)

All Known Implementing Classes:

IntegratedCase, curam.core.facade.impl.IntegratedCase, IntegratedCaseFactory
```
@AccessLevel(value=EXTERNAL)
public interface IntegratedCase
```
This business interface provides operations related to integrated cases.

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`curam.core.facade.struct.CreatedCaseIDKey`	`addProductToIntegratedCase(curam.core.facade.struct.AddProductToICDetails details)` Adds a product delivery to an integrated case.
`void`	`addTaskToContract(curam.core.facade.struct.AddTaskToContractKey key)` Adds a task to a contract on an integrated case.
`void`	`cancelContract(curam.core.facade.struct.CancelContractKey key)` Cancels a contract on an integrated case.
`void`	`cancelMemberNote(curam.core.facade.struct.CancelMemberNoteKey key)` Cancels an integrated case member note.
`void`	`closeCase(curam.core.facade.struct.ICClosureDetails key)` Closes an integrated case and records closure details.
`curam.core.struct.InformationalMsgDtlsList`	`countActiveTasks(curam.core.struct.CaseKey caseKey)` Returns a count of the active tasks on a case.
`curam.core.facade.struct.CreateAssessmentDeliveryDetails`	`createAssessment(curam.core.facade.struct.CreateAssessmentDeliveryKey key)` Creates an assessment on an integrated case.
`curam.core.facade.struct.CaseCreationDetails`	`createCaseHelper(curam.core.facade.struct.CaseCreationDetails caseCreationDetails)` Is used in the case creation wizard to hold the case member and product values selected on the case member page.
`curam.core.facade.struct.CreateContractKey`	`createContract(curam.core.facade.struct.CreateContractDetails details)` Creates a contract on an integrated case.
`void`	`createEvidenceMetadata(curam.core.facade.struct.ICEvidenceMetadataDetails details)` Creates evidence metadata for an integrated case.
`void`	`createICEvidenceLink(curam.core.facade.struct.ICEvidenceLinkDetails details)` Creates integrated case evidence.
`curam.core.facade.struct.CreateIntegratedCaseResult`	`createIntegratedCase1(curam.core.facade.struct.CreateIntegratedCaseDetails1 details)` Creates an integrated case.
`curam.core.facade.struct.CreateIntegratedCaseResultAndMessages`	`createIntegratedCaseAndRegisterPerson(curam.core.facade.struct.CreateICAndRegisterPerson details)` Creates an integrated case and registers a person.
`curam.core.facade.struct.CreateIntegratedCaseResultAndMessages`	`createIntegratedCaseAndRegisterProspectPerson(curam.core.facade.struct.CreateICAndRegisterProspectPerson details)` Creates an integrated case and registers a prospect person.
`curam.core.facade.struct.CreateContractKey`	`createMemberContract(curam.core.facade.struct.CreateContractDetails details)` Creates a contract on a case for a case member.
`void`	`createMemberNote1(curam.core.facade.struct.CreateMemberNoteDetails1 details)` Creates an integrated case member note.
`curam.core.facade.struct.NewActivityDetails_fo`	`createRecurringrActivity(curam.core.facade.struct.RecurringrActivityDetails details)` Creates a new recurring activity for the current user.
`curam.core.facade.struct.NewActivityDetails_fo`	`createStandardUserActivity(curam.core.facade.struct.StandardActivityDetails details)` Creates a new activity for the current user.
`void`	`deleteICEvidenceLink(curam.core.sl.infrastructure.struct.ICEvidenceLinkAndEvidenceTypeKey key)` Deletes integrated case evidence.
`curam.core.facade.struct.ListMemberDetails`	`getCaseParticipantsAgeConcernRoleID(curam.core.facade.struct.CaseID caseID)` Lists the name, age and concern role id for the case participants on an integrated case.
`curam.core.facade.struct.ListICAccessibleNoteDetails1`	`listAccessibleNote1(curam.core.facade.struct.ListICNotesKey key)` Returns a list of accessible notes on an integrated case.
`curam.core.facade.struct.ListICClientRoleDetails`	`listActiveCaseMembers(curam.core.sl.struct.CaseIDKey key)` Returns a list of active case members.
`curam.core.sl.struct.ViewCaseParticipantRoleDetailsList`	`listActiveCaseMembersByCaseParticipantRoleID(curam.core.facade.struct.CaseParticipantRoleKey key)` Returns a list of active case members for the case on which the case participant belongs.
`curam.core.facade.struct.ListMemberDetails`	`listActiveCaseMembersForCommunicationsFilter(curam.core.sl.struct.CaseIDKey key)` Returns a list of active case members.
`curam.core.facade.struct.ListICProductDeliveryDecision`	`listActiveProductDeliveryDecision(curam.core.facade.struct.ListICProductDeliveryDecisionKey key)` Returns a list of active product delivery decisions.
`curam.core.facade.struct.ListICProductDeliveryDeductionDetails`	`listActiveProductDeliveryDeduction(curam.core.facade.struct.ListICProductDeliveryDeductionKey key)` Returns a list of active deductions for a product delivery.
`curam.core.facade.struct.ListICAdminCaseRoleDetails`	`listAdminCaseRole(curam.core.facade.struct.ListICAdminCaseRoleKey key)` Returns a list of users with administration roles on an integrated case.
`curam.core.facade.struct.ListCasesByConcernRoleDetails`	`listAllCases(curam.core.facade.struct.CaseParticipantRoleKey key)` Returns a list of all cases for a case participant.
`curam.core.facade.struct.ListICAllCasesDetails`	`listAllCasesForParentCase(curam.core.facade.struct.IntegratedCaseIDKey key)` Returns all cases that are part of an integrated case.
`curam.core.facade.struct.ListICAssessmentDetails`	`listAssessment(curam.core.facade.struct.ListICAssessmentKey key)` Returns a list of assessments on the integrated case.
`curam.core.facade.struct.ListICAttachmentDetails`	`listAttachment(curam.core.facade.struct.ListICAttachmentsKey key)` Returns a list of attachments on an integrated case.
`curam.core.facade.struct.CommunicationDetailList`	`listCaseMemberCommunication(curam.core.facade.struct.CaseParticipantRoleKey key)` Returns a list of communications for a case member.
`curam.core.facade.struct.ListICClientRoleDetails1`	`listCaseMembers1(curam.core.facade.struct.ListICClientKey key)` Returns a list of case members for a case.
`curam.core.facade.struct.ListICClientRoleDetails`	`listCaseMembersExcProspectPerson(curam.core.facade.struct.ListICClientKey key)` Returns a list of case members for a case excluding prospect persons.
`curam.core.facade.struct.ListMemberDetails`	`listCaseParticipantsDetails(curam.core.facade.struct.ListMemberDetailsKey key)` Returns a list of case participants for an integrated case without any duplicates.
`curam.core.facade.struct.ListMemberDetails`	`listCaseParticipantsDetailsForContactLog(curam.core.facade.struct.ListMemberDetailsKey listMemberDetailsKey)` Returns a list of case members for a case when the 'members only for contact log' property is set to true in administration.
`curam.core.facade.struct.ListMemberDetails`	`listCaseParticipantsDetailsUsingCaseParticipantRoleID(curam.core.facade.struct.CaseParticipantRoleKey key)` Returns a list of case participants for a case on which the given case participant exists.
`curam.core.facade.struct.ListMemberDetails`	`listCaseParticipantsWithAge(curam.core.facade.struct.ListMemberDetailsKey key)` Returns a list of case participants for a case with their age appended to their name.
`curam.core.facade.struct.ListICCaseRelationshipDetails`	`listCaseRelationship(curam.core.facade.struct.ListICCaseRelationshipKey key)` Returns a list of related cases for an integrated case.
`curam.core.facade.struct.ListICClientRoleDetails`	`listClientRole(curam.core.facade.struct.ListICClientKey key)` Returns a list of clients and their role on an integrated case.
`curam.core.facade.struct.ListContractDetails`	`listContract(curam.core.facade.struct.ListContractKey key)` Deprecated. by listContractDetails.
`curam.core.facade.struct.ListCaseContractDetails`	`listContractDetails(curam.core.facade.struct.ListContractKey listContractKey)` Returns the list of available contract details for a case.
`curam.core.facade.struct.EvidenceMetadataDetailsList`	`listCurrentActiveEvidenceMetadata(curam.core.struct.AdminIntegratedCaseKey key)` Returns a list of currently active evidence details.
`curam.core.facade.struct.ListDeliveryPatternHistoryDetails`	`listCurrentDeliveryPattern(curam.core.sl.struct.ProductDeliveryPatternByCaseIDKey key)` lists all current delivery pattern details for a case.
`curam.core.facade.struct.CurrentDeductionsForProductDeliveryList`	`listCurrentProductDeliveryDeduction(curam.core.facade.struct.ListICProductDeliveryDeductionKey key)` Returns a list of the current deductions for an integrated case product delivery.
`curam.core.facade.struct.ListMemberDetails`	`listDeductionCaseParticipantWithoutProspect(curam.core.facade.struct.ListMemberDetailsKey key)` Returns a list of case participants used in deductions creation.
`curam.core.facade.struct.ListICEventDetails1`	`listEvent1(curam.core.facade.struct.ListICEventKey key)` Returns a list of events on an integrated case.
`curam.core.facade.struct.CommunicationDetailList`	`listFilteredCommunication(curam.core.facade.struct.CommunicationFilterKey key)` Returns a list of communications for the primary client (even if they are not the correspondent) or a specified case member.
`curam.core.facade.struct.ICEvidenceTypeDetails`	`listICEvidenceLink(curam.core.struct.AdminIntegratedCaseKey key)` Returns a list of all evidence types for an integrated case.
`curam.core.facade.struct.IntegratedInvestigationListDetails`	`listInvestigation(curam.core.struct.CaseHeaderKey key)` Returns a list of investigations for an integrated case.
`curam.core.facade.struct.ICInvestigationDeliveryActionPlanList`	`listInvestigationDeliveryActionPlan(curam.core.sl.entity.struct.LinkKey key)` Returns a list of action plans for an investigation on an integrated case.
`curam.core.facade.struct.ICInvestigationDeliveryAllegationList`	`listInvestigationDeliveryAllegation(curam.core.struct.CaseHeaderKey key)` Returns a list of allegations for an investigation on an integrated case.
`curam.core.facade.struct.ICInvestigationDeliveryAssessmentList`	`listInvestigationDeliveryAssessment(curam.core.struct.CaseHeaderKey key)` Returns a list of assessments for an investigation on an integrated case.
`curam.core.facade.struct.ICInvestigationDeliveryAttachmentList`	`listInvestigationDeliveryAttachment(curam.core.struct.CaseHeaderKey key)` Returns a list of attachments for an investigation on an integrated case.
`curam.core.facade.struct.ICInvestigationDeliveryClientRoleList`	`listInvestigationDeliveryCaseMember(curam.core.struct.CaseHeaderKey key)` Returns a list of investigation case members.
`curam.core.facade.struct.ICInvestigationDeliveryClientRoleList`	`listInvestigationDeliveryClientRole(curam.core.struct.CaseHeaderKey key)` Returns a list of investigation case participants with their client roles.
`curam.core.facade.struct.ICInvestigationDeliveryContactLogList1`	`listInvestigationDeliveryContactLog1(curam.core.struct.CaseHeaderKey key)` Returns a list of contact logs for an investigation on an integrated case.
`curam.core.facade.struct.ICInvestigationDeliveryEventList1`	`listInvestigationDeliveryEvent1(curam.core.struct.CaseHeaderKey key)` Returns a list of events for an investigation delivery on an integrated case.
`curam.core.facade.struct.ICInvestigationDeliveryMilestoneList`	`listInvestigationDeliveryMilestone(curam.core.struct.CaseHeaderKey key)` Returns a list of milestones for an investigation on an integrated case.
`curam.core.facade.struct.ICInvestigationDeliveryNoteList1`	`listInvestigationDeliveryNote1(curam.core.struct.CaseHeaderKey key)` Returns a list of notes for an investigation on an integrated case.
`curam.core.facade.struct.ICInvestigationDeliveryRelatedCaseList`	`listInvestigationDeliveryRelatedCase(curam.core.struct.CaseHeaderKey key)` Returns a list of related cases for an investigation on an integrated case.
`curam.core.facade.struct.ICInvestigationDeliveryStatusHistoryList1`	`listInvestigationDeliveryStatusHistory1(curam.core.struct.CaseHeaderKey key)` Returns a status history list for an investigation on an integrated case.
`curam.core.facade.struct.ICInvestigationDeliveryTaskList`	`listInvestigationDeliveryTask(curam.core.struct.CaseHeaderKey key)` Returns a list of tasks for an investigation on an integrated case.
`curam.core.facade.struct.ICInvestigationDeliveryUserRoleList`	`listInvestigationDeliveryUserRole(curam.core.struct.CaseHeaderKey key)` Returns a list of user roles for an investigation on an integrated case.
`curam.core.facade.struct.ICInvestigationDeliveryMilestoneList`	`listInvestigationUncompletedMilestone(curam.core.struct.CaseHeaderKey key)` Returns a list of uncompleted milestones for an investigation on an integrated case.
`curam.core.facade.struct.IssueCaseDtlsList`	`listIssue(curam.core.struct.CaseHeaderKey caseHeaderKey)` Return a list all the issues on an integrated case.
`curam.core.facade.struct.ListICProductDeliveryDetails`	`listLiabilityProduct(curam.core.facade.struct.IntegratedCaseIDKey key)` Returns a list of liability cases on an integrated case.
`curam.core.facade.struct.ListMemberActivityDetails`	`listMemberActivity(curam.core.facade.struct.CaseParticipantRoleKey key)` Returns a list of activities for a member of an integrated case.
`curam.core.facade.struct.ListMemberAndContractTemplateDetails`	`listMemberAndContractTemplate(curam.core.facade.struct.ListMemberAndContractTemplateKey key)` Returns a list of members for the integrated case and a list of case contract templates.
`curam.core.facade.struct.ListICMemberAssessmentDetails`	`listMemberAssessment(curam.core.facade.struct.CaseParticipantRoleKey key)` Returns a list of assessments for a member on an integrated case.
`curam.core.facade.struct.ListMemberContractDetails`	`listMemberContract(curam.core.facade.struct.CaseParticipantRoleKey key)` Returns a list of contracts for a member on an integrated case.
`curam.core.facade.struct.ListMemberAndContractTemplateDetails`	`listMemberContractDetails(curam.core.facade.struct.CaseParticipantRoleKey key)` Returns a list of contracts for case member on an integrated case.
`curam.core.facade.struct.ListMemberDetails`	`listMemberDetails(curam.core.facade.struct.ListMemberDetailsKey key)` Returns a list of members on an integrated case.
`curam.core.facade.struct.ListMemberFinancialDetails`	`listMemberFinancial(curam.core.facade.struct.CaseParticipantRoleKey key)` Returns a list of financials for a member on an integrated case.
`curam.core.facade.struct.IssueDeliveryForICMemberDtlsList`	`listMemberIssue(curam.core.sl.entity.struct.CaseParticipantRoleKey caseParticipantRoleKey)` Returns a list of issues for a case participant on an integrated case.
`curam.core.facade.struct.ListMemberNoteDetails1`	`listMemberNote1(curam.core.facade.struct.CaseParticipantRoleKey key)` Returns a list of notes relating to a member of an integrated case.
`curam.core.facade.struct.ListICMemberProductDeliveryDetails`	`listMemberProduct(curam.core.facade.struct.CaseParticipantRoleKey key)` Returns a list of product deliveries for an integrated case member.
`curam.core.facade.struct.ListMemberTaskDetails`	`listMemberTasks(curam.core.facade.struct.CaseParticipantRoleKey key)` Returns a list of tasks assigned to a member of an integrated case.
`curam.core.facade.struct.ListICPDAccessibleNoteDetails1`	`listPDAccessibleNote1(curam.core.facade.struct.ListICProductDeliveryNoteKey key)` Returns a list of accessible notes on a product delivery.
`curam.core.facade.struct.ListICProductDeliveryDetails`	`listProduct(curam.core.facade.struct.IntegratedCaseIDKey key)` Returns a list of products deliveries on an integrated case.
`curam.core.facade.struct.ListICProductDeliveryAdminCaseRole`	`listProductDeliveryAdminCaseRole(curam.core.facade.struct.ListICProductDeliveryAdminCaseRoleKey key)` Returns a list of administration user roles for a product delivery on an integrated case.
`curam.core.facade.struct.ListICProductDeliveryDeductionDetails`	`listProductDeliveryAppliedUnappliedDeduction(curam.core.facade.struct.ListICProductDeliveryDeductionKey key)` Returns a list of applied and un-applied deductions for a product delivery.
`curam.core.facade.struct.ListICProductDeliveryAttachmentDetails`	`listProductDeliveryAttachment(curam.core.facade.struct.ListICProductDeliveryAttachmentKey key)` Returns a list of attachments for a product delivery on an integrated case.
`curam.core.facade.struct.ListICProductDeliveryCaseRelationship`	`listProductDeliveryCaseRelationship(curam.core.facade.struct.ListICProductDeliveryCaseRelationshipKey key)` Returns a list of related cases to a product delivery.
`curam.core.facade.struct.ListICProductDeliveryCertDetails1`	`listProductDeliveryCertification1(curam.core.facade.struct.CertificationCaseIDKey key)` Returns a list of certifications on a product delivery.
`curam.core.facade.struct.ListICProductDeliveryCertDetailsAndVersionNo`	`listProductDeliveryCertificationAndVersionNo(curam.core.facade.struct.CertificationCaseIDKey key)` Returns a list of certifications on a product delivery.
`curam.core.facade.struct.ListICProductDeliveryClientRoleDetails`	`listProductDeliveryClientRole(curam.core.facade.struct.ListICProductDeliveryClientRoleKey key)` Returns a list of client roles for a product delivery on an integrated case.
`curam.core.facade.struct.ListICProductDeliveryDecision`	`listProductDeliveryDecision(curam.core.facade.struct.ListICProductDeliveryDecisionKey key)` Returns a list of product delivery case decisions on an integrated case.
`curam.core.facade.struct.ListICProductDeliveryDeductionDetails`	`listProductDeliveryDeductionHistory(curam.core.facade.struct.ListICProductDeliveryDeductionKey key)` Returns a list of deductions for a product delivery that are not current.
`curam.core.facade.struct.ListICProductDeliveryEventDetails1`	`listProductDeliveryEvent1(curam.core.facade.struct.ListICProductDeliveryEventKey key)` Returns a list of events for a product delivery on an integrated case.
`curam.core.facade.struct.ListICProductDeliveryEvidenceDetails`	`listProductDeliveryEvidence(curam.core.facade.struct.ListICProductDeliveryEvidenceKey key)` Returns a list of evidence for a product delivery on an integrated case.
`curam.core.facade.struct.ListICProductDeliveryFinancialDetails`	`listProductDeliveryFinancial(curam.core.facade.struct.ListICProductDeliveryFinancialsKey key)` Returns a list of financials for a product delivery on an integrated Case.
`curam.core.facade.struct.ListICProductDeliveryInstructionDetails`	`listProductDeliveryFinInstruction(curam.core.facade.struct.ListICProductDeliveryFinancialsKey key)` Returns a list of financials for a product delivery on an integrated case.
`curam.core.facade.struct.ListDeliveryPatternHistoryDetails`	`listProductDeliveryInfoDetailsForCase(curam.core.sl.struct.ProductDeliveryPatternByCaseIDKey key)` Returns a list of the delivery pattern details for a product delivery.
`curam.core.facade.struct.IssueCaseDtlsList`	`listProductDeliveryIssue(curam.core.struct.CaseHeaderKey caseHeaderKey)` Returns a list of issues for a product delivery.
`curam.core.facade.struct.CaseNomineeDetailsWithVersionNoList`	`listProductDeliveryNominee1(curam.core.facade.struct.ListICProductDeliveryNomineeKey key)` Returns a list of nominees for a product delivery on an integrated case.
`curam.core.facade.struct.ListICProductDeliveryObjectiveAndDelPatt`	`listProductDeliveryObjectiveAndDelPatt(curam.core.facade.struct.ListObjectiveKey key)` Returns a list of objectives available on a product delivery.
`curam.core.facade.struct.ListICProductDeliveryOverUnderPaymentDetails`	`listProductDeliveryOverUnderPayment(curam.core.facade.struct.ListICProductDeliveryOverUnderPaymentKey key)` Returns a list of over payment cases and under payment cases on an integrated case product delivery.
`curam.core.facade.struct.ListTransactionsLogDetails`	`listProductDeliveryRecentTransaction(curam.core.struct.CaseHeaderKey caseHeaderKey)` Returns a list of the recent transactions on a product delivery.
`curam.core.facade.struct.ListICProductDeliveryStatusHistory1`	`listProductDeliveryStatusHistory1(curam.core.facade.struct.ListICProductDeliveryStatusHistoryKey key)` Returns the status history for a product delivery within an integrated case.
`curam.core.facade.struct.ListICProductDeliveryTaskDetails`	`listProductDeliveryTask(curam.core.facade.struct.ListICProductDeliveryTaskKey_eo key)` Returns a list of tasks for a product delivery on an integrated case.
`curam.core.facade.struct.ListICProductDeliveryDeductionDetails`	`listProductDeliveryThirdPartyDeduction(curam.core.facade.struct.ListICProductDeliveryDeductionKey key)` Returns a list of third party deductions on a product delivery.
`curam.core.facade.struct.ListICProductDeliveryUtility`	`listProductDeliveryUtilityPayment(curam.core.facade.struct.ListICProductDeliveryUtilityKey key)` Returns a list of utility payments for a product delivery.
`curam.core.facade.struct.ListProductsForCategoryDetails`	`listProductsForCategory(curam.core.facade.struct.CaseParticipantRoleKey key)` Returns a list of products in a particular category for a case participant's case type.
`curam.core.facade.struct.ListTransactionsLogDetails`	`listRecentTransaction(curam.core.struct.CaseHeaderKey caseKey)` Returns a list of the recent transactions on a case.
`curam.core.facade.struct.SpecialCautionsList`	`listSpecialCaution(curam.core.facade.struct.CaseParticipantRoleKey key)` Returns a list of the special cautions for a case participant.
`curam.core.facade.struct.SpecialCautionsList`	`listSpecialCautionHistory(curam.core.facade.struct.CaseParticipantRoleKey key)` Returns a list of the special cautions for a case member that have been cancelled or have end dates that have passed.
`curam.core.sl.struct.CaseSpecialCautionDetailsList`	`listSpecialCautionHistoryForCase(curam.core.struct.CaseID key)` Returns a list of the special cautions for a case that have been cancelled or have end dates that have passed.
`curam.core.sl.struct.CaseSpecialCautionDetailsList`	`listSpecialCautionsForCase(curam.core.struct.CaseID key)` Returns a list of special cautions for case members on a case.
`curam.core.facade.struct.ListICTaskDetails`	`listTask(curam.core.facade.struct.ListICTaskKey_eo key)` Returns a list of tasks on an integrated case.
`curam.core.facade.struct.ListTasksDueDuringContractPeriod`	`listTasksDueDuringContractPeriod(curam.core.facade.struct.ListTasksDueKey key)` Returns a list of tasks due over a contract's period.
`void`	`modifyCaseDetails(curam.core.facade.struct.ModifyIntegratedCaseDetails details)` Modifies an integrated case's details.
`void`	`modifyContract(curam.core.facade.struct.ModifyContractDetails details)` Modifies the details of a contract on an integrated case.
`void`	`modifyMemberNote1(curam.core.facade.struct.ModifyMemberNoteDetailsKey key, curam.core.facade.struct.ModifyMemberNoteDetails1 details)` Modifies the details of an integrated case member note.
`void`	`printContract(curam.core.facade.struct.PrintContractDetails details)` Prints a contract.
`curam.core.facade.struct.ReadIntegratedCaseDetails1`	`readCaseDetails1(curam.core.facade.struct.IntegratedCaseIDKey key)` Reads the details of an integrated case.
`curam.core.facade.struct.ReadIntegratedCaseDetails1`	`readCaseDetails2(curam.core.facade.struct.IntegratedCaseIDKey key)` Reads the details of an integrated case.
`curam.core.sl.entity.struct.CaseIDAndParticipantRoleIDDetails`	`readCaseIDandParticipantRoleIDDetails(curam.core.facade.struct.CaseParticipantRoleKey key)` Reads the case id and participant role id for a case particpant.
`curam.core.struct.ConcernRoleID`	`readConcernRoleID(curam.core.facade.struct.CaseParticipantRoleKey key)` Reads the concern role id for a member of an integrated case.
`curam.core.facade.struct.ReadContractDetails`	`readContractDetails(curam.core.facade.struct.ReadCaseContractKey key)` Reads details for a contract and also tasks due on an integrated case.
`curam.core.facade.struct.ReadICEmployerDetails`	`readEmployerDetails(curam.core.facade.struct.CaseParticipantRoleKey key)` Reads the details for an employer case participant on an integrated case.
`curam.core.facade.struct.ICBenefitUnderpmtHomePageDetails1`	`readICBenefitUnderpmtHomePageDetails1(curam.core.facade.struct.ReadICProductHomePageKey key)` Reads details to populate an integrated case benefit underpayment home page.
`curam.core.facade.struct.ReadICProductHomePageDetails1`	`readICProductHomePageDetails1(curam.core.facade.struct.ReadICProductHomePageKey key)` Reads the home page details for a product on an integrated case.
`curam.core.facade.struct.ReadICInformationProviderDetails`	`readInformationProviderDetails(curam.core.facade.struct.CaseParticipantRoleKey key)` Reads the details for an information provider case participant on an integrated case.
`curam.core.facade.struct.ReadICMemberDetails`	`readMemberDetails(curam.core.facade.struct.CaseParticipantRoleKey key)` Reads the details for a member of an integrated case.
`curam.core.facade.struct.ReadMemberNoteDetails1`	`readMemberNote1(curam.core.facade.struct.ReadMemberNoteKey key)` Reads the details of a member note on an integrated case.
`curam.core.facade.struct.CaseNomineeDeliveryPatternDetails`	`readNearestDeliveryPatternForCaseNominee(curam.core.facade.struct.CaseNomineeAndEffectiveDateKey key)` Reads the nearest active delivery pattern for a case nominee on an integrated case.
`curam.core.facade.struct.ReadOverviewDetails`	`readOverview()` Placeholder method used to add the Overview Renderer to the Case.
`curam.core.facade.struct.MessageXMLResult`	`readOverviewMessageXML()` Reads the messages XML details of a case.
`curam.core.facade.struct.ReadICPersonDetails`	`readPersonDetails(curam.core.facade.struct.CaseParticipantRoleKey key)` Reads the details for a person case participant on an integrated case.
`curam.core.facade.struct.ReadICProductProviderDetails`	`readProductProviderDetails(curam.core.facade.struct.CaseParticipantRoleKey key)` Reads the details for a product provider case participant on an integrated case.
`curam.core.facade.struct.ReadICPersonDetails`	`readProspectPersonDetails(curam.core.facade.struct.CaseParticipantRoleKey key)` Returns the details for a prospect person case participant on an integrated case.
`curam.core.facade.struct.ReadICRepresentativeDetails`	`readRepresentativeDetails(curam.core.facade.struct.CaseParticipantRoleKey key)` Returns the details for a representative case participant on an integrated case.
`curam.core.facade.struct.ReadICServiceSupplierDetails`	`readServiceSupplierDetails(curam.core.facade.struct.CaseParticipantRoleKey key)` Reads the details for a service supplier case participant on an integrated case.
`curam.core.sl.struct.CaseParticipantRoleFullDetails1`	`readTranslationRequiredInd(curam.core.sl.struct.CaseIDKey key)` Reads the primary case participant's details including if they need a translator for an integrated case.
`curam.core.sl.struct.CaseParticipantRoleDtlsList`	`readTranslatorRequiredForMember(curam.core.facade.struct.IntegratedCaseIDKey key)` Returns a list of case members details including if they need a translator for an integrated case.
`curam.core.facade.struct.ReadICUtilityDetails`	`readUtilityDetails(curam.core.facade.struct.CaseParticipantRoleKey key)` Reads the details for a utility case participant on an integrated case.
`void`	`removeTaskFromContract(curam.core.facade.struct.RemoveTaskFromContractKey key)` Cancels a task from a contract on an integrated case.
`void`	`reopenCase(curam.core.facade.struct.ReactivationDetails reactivationDetails)` Reopens a closed integrated case.
`curam.core.facade.struct.ResolveHomePageDetails`	`resolveCaseHome(curam.core.facade.struct.ResolveHomePageKey key)` Return the home page name for an integrated case.
`curam.core.facade.struct.MemberHomePageName`	`resolveMemberHome(curam.core.facade.struct.IntegratedCaseIDKey key)` Returns the home page name for case members on an integrated case.
`curam.core.facade.struct.ParticipantHomePageName`	`resolveParticipantHome(curam.core.facade.struct.CaseParticipantRoleIDKey key)` Returns the home page name for participants on an integrated case
`curam.core.facade.struct.ICCaseEventAndActivityDetails1`	`searchICCaseEventAndActivity1(curam.core.facade.struct.SearchCaseEventAndActivityKey key)` Returns case events and activities from a specified start date for an integrated case calendar.
`curam.core.facade.struct.ICMemberActivityDetails`	`searchICMemberActivity(curam.core.facade.struct.SearchICMemberActivityKey key)` Returns case activities for a case member on an integrated case.
`curam.core.facade.struct.ICProductDeliveryEventAndActivityDetails1`	`searchICProductDeliveryEventAndActivity1(curam.core.facade.struct.SearchCaseEventAndActivityKey key)` Returns case events and activities from a specified start date for a product delivery calendar.
`curam.core.facade.struct.ICInvestigationEventAndActivityDetails1`	`searchInvestigationEventAndActivity1(curam.core.facade.struct.SearchCaseEventAndActivityKey key)` Returns case events and activities from a specified start date for an investigation calendar.

Method Detail

readOverview

curam.core.facade.struct.ReadOverviewDetails readOverview()
                                                   throws curam.util.exception.AppException,
                                                          curam.util.exception.InformationalException

Placeholder method used to add the Overview Renderer to the Case.

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

addProductToIntegratedCase

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.CreatedCaseIDKey addProductToIntegratedCase(curam.core.facade.struct.AddProductToICDetails details)
                                                                                           throws curam.util.exception.AppException,
                                                                                                  curam.util.exception.InformationalException

Adds a product delivery to an integrated case.

Parameters:

details - The details to create the product delivery.

Returns:

The case id of the created product delivery.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Product, ConcernRole

Business Object Write:

Case, ProductDelivery, Verification

addTaskToContract

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

Adds a task to a contract on an integrated case.

Parameters:

key - Details of the task.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

CaseContract

cancelContract

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

Cancels a contract on an integrated case.

Parameters:

key - The contract id.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

CaseContract

cancelMemberNote

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

Cancels an integrated case member note.

Parameters:

key - The integrated case member note id.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

Note

closeCase

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

Closes an integrated case and records closure details.

Parameters:

key - The integrated case id and closure details.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

Case

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 an integrated case.

Parameters:

key - The details of the assessment.

Returns:

The assessment id.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

Assessment

createCaseHelper

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.CaseCreationDetails createCaseHelper(curam.core.facade.struct.CaseCreationDetails caseCreationDetails)
                                                                                    throws curam.util.exception.AppException,
                                                                                           curam.util.exception.InformationalException

Is used in the case creation wizard to hold the case member and product values selected on the case member page. These values are then read on the subsequent wizard page.

Returns:: The case creation details.
Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

createContract

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.CreateContractKey createContract(curam.core.facade.struct.CreateContractDetails details)
                                                                                throws curam.util.exception.AppException,
                                                                                       curam.util.exception.InformationalException

Creates a contract on an integrated case.

Parameters:

details - The details of the contract.

Returns:

The contract id.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

ConcernRole

Business Object Write:

CaseContract

createEvidenceMetadata

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

Creates evidence metadata for an integrated case.

Parameters:

details - The evidence metadata details.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

Evidence

createICEvidenceLink

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

Creates integrated case evidence.

Parameters:

dtls - The evidence details

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

Evidence

createMemberContract

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.CreateContractKey createMemberContract(curam.core.facade.struct.CreateContractDetails details)
                                                                                      throws curam.util.exception.AppException,
                                                                                             curam.util.exception.InformationalException

Creates a contract on a case for a case member.

Parameters:

details - The contract details.

Returns:

The contract id.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

ConcernRole

Business Object Write:

CaseContract

createRecurringrActivity

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.NewActivityDetails_fo createRecurringrActivity(curam.core.facade.struct.RecurringrActivityDetails details)
                                                                                              throws curam.util.exception.AppException,
                                                                                                     curam.util.exception.InformationalException

Creates a new recurring activity for the current user.

Parameters:

details - The details of the recurring activity.

Returns:

The activity id.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

ConcernRole, ActivityAttendee

Business Object Write:

Activity, ActivityAttendee

createStandardUserActivity

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.NewActivityDetails_fo createStandardUserActivity(curam.core.facade.struct.StandardActivityDetails details)
                                                                                                throws curam.util.exception.AppException,
                                                                                                       curam.util.exception.InformationalException

Creates a new activity for the current user.

Parameters:

details - The details of the recurring activity.

Returns:

The activity id.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

ConcernRole, ActivityAttendee

Business Object Write:

Activity, ActivityAttendee

deleteICEvidenceLink

@AccessLevel(value=EXTERNAL)
void deleteICEvidenceLink(curam.core.sl.infrastructure.struct.ICEvidenceLinkAndEvidenceTypeKey key)
                                                throws curam.util.exception.AppException,
                                                       curam.util.exception.InformationalException

Deletes integrated case evidence.

Parameters:

key - The evidence identifier.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

Evidence

listActiveCaseMembers

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

Returns a list of active case members.

Parameters:

key - The integrated case id.

Returns:

A list of active case members.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

CaseParticipant, Case

listActiveCaseMembersByCaseParticipantRoleID

@AccessLevel(value=EXTERNAL)
curam.core.sl.struct.ViewCaseParticipantRoleDetailsList listActiveCaseMembersByCaseParticipantRoleID(curam.core.facade.struct.CaseParticipantRoleKey key)
                                                                                                                           throws curam.util.exception.AppException,
                                                                                                                                  curam.util.exception.InformationalException

Returns a list of active case members for the case on which the case participant belongs.

Parameters:

key - The case participant role id.

Returns:

A list of active integrated case members.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

CaseParticipant, ConcernRole, SpecialCaution

listActiveProductDeliveryDecision

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListICProductDeliveryDecision listActiveProductDeliveryDecision(curam.core.facade.struct.ListICProductDeliveryDecisionKey key)
                                                                                                               throws curam.util.exception.AppException,
                                                                                                                      curam.util.exception.InformationalException

Returns a list of active product delivery decisions.

Parameters:: key - The product delivery id.
Returns:: A list of active decision details.
Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listActiveProductDeliveryDeduction

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListICProductDeliveryDeductionDetails listActiveProductDeliveryDeduction(curam.core.facade.struct.ListICProductDeliveryDeductionKey key)
                                                                                                                        throws curam.util.exception.AppException,
                                                                                                                               curam.util.exception.InformationalException

Returns a list of active deductions for a product delivery.

Parameters:

key - The product delivery id.

Returns:

A list of active deductions.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Deduction, Case

listAdminCaseRole

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

Returns a list of users with administration roles on an integrated case.

Parameters:

key - The integrated case id.

Returns:

A list of users with admin roles.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

CaseUserRole

listAllCases

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListCasesByConcernRoleDetails listAllCases(curam.core.facade.struct.CaseParticipantRoleKey key)
                                                                                          throws curam.util.exception.AppException,
                                                                                                 curam.util.exception.InformationalException

Returns a list of all cases for a case participant.

Parameters:

key - The case participant id.

Returns:

A list of cases for the case participant.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Case, CaseParticipant, CaseUserRole, ProductDelivery, Screening, Assessment, ServicePlan, Issue, Investigation

listAllCasesForParentCase

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListICAllCasesDetails listAllCasesForParentCase(curam.core.facade.struct.IntegratedCaseIDKey key)
                                                                                               throws curam.util.exception.AppException,
                                                                                                      curam.util.exception.InformationalException

Returns all cases that are part of an integrated case.

Parameters:

key - The integrated case id.

Returns:

A list of cases.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Case

listAssessment

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

Returns a list of assessments on the integrated case.

Parameters:

key - The integrated case id.

Returns:

A list of assessment details.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Case, Assessment

listAttachment

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

Returns a list of attachments on an integrated case.

Parameters:

key - The integrated case id.

Returns:

A list of attachments.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Attachment

listCaseMembersExcProspectPerson

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListICClientRoleDetails listCaseMembersExcProspectPerson(curam.core.facade.struct.ListICClientKey key)
                                                                                                        throws curam.util.exception.AppException,
                                                                                                               curam.util.exception.InformationalException

Returns a list of case members for a case excluding prospect persons.

Parameters:

key - The integrated case id

Returns:

A list of case members.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

ConcernRole, CaseParticipant

listCaseParticipantsDetails

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListMemberDetails listCaseParticipantsDetails(curam.core.facade.struct.ListMemberDetailsKey key)
                                                                                             throws curam.util.exception.AppException,
                                                                                                    curam.util.exception.InformationalException

Returns a list of case participants for an integrated case without any duplicates.

Parameters:

key - The integrated case id.

Returns:

A list of case participants.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Case, CaseParticipant

listCaseParticipantsDetailsUsingCaseParticipantRoleID

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListMemberDetails listCaseParticipantsDetailsUsingCaseParticipantRoleID(curam.core.facade.struct.CaseParticipantRoleKey key)
                                                                                                                       throws curam.util.exception.AppException,
                                                                                                                              curam.util.exception.InformationalException

Returns a list of case participants for a case on which the given case participant exists.

Parameters:

key - The case participant id.

Returns:

A list of case participants.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

CaseParticipant

listCaseRelationship

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListICCaseRelationshipDetails listCaseRelationship(curam.core.facade.struct.ListICCaseRelationshipKey key)
                                                                                                  throws curam.util.exception.AppException,
                                                                                                         curam.util.exception.InformationalException

Returns a list of related cases for an integrated case.

Parameters:

key - The integrated case id.

Returns:

A list of related cases.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Case, CaseRelationship

listClientRole

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

Returns a list of clients and their role on an integrated case.

Parameters:

key - The integrated case id.

Returns:

A list of clients and their roles.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

CaseParticipant, SpecialCaution

listContract

@Deprecated
 @AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListContractDetails listContract(curam.core.facade.struct.ListContractKey key)
                                                                                             throws curam.util.exception.AppException,
                                                                                                    curam.util.exception.InformationalException

Deprecated. by listContractDetails.

Returns a list of contracts on an integrated case.

Parameters:

key - The integrated case id.

Returns:

A list of contracts.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

CaseContract, ConcernRole, CaseParticipant

listCurrentActiveEvidenceMetadata

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.EvidenceMetadataDetailsList listCurrentActiveEvidenceMetadata(curam.core.struct.AdminIntegratedCaseKey key)
                                                                                                             throws curam.util.exception.AppException,
                                                                                                                    curam.util.exception.InformationalException

Returns a list of currently active evidence details.

Parameters:

key - The administration integrated case id.

Returns:

A list of evidence records.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Evidence

listICEvidenceLink

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ICEvidenceTypeDetails listICEvidenceLink(curam.core.struct.AdminIntegratedCaseKey key)
                                                                                        throws curam.util.exception.AppException,
                                                                                               curam.util.exception.InformationalException

Returns a list of all evidence types for an integrated case.

Parameters:

The - admin integrated case id.

Returns:

A list of evidence types.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Evidence

listInvestigation

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

Returns a list of investigations for an integrated case.

Parameters:

key - The integrated case id.

Returns:

A list of investigations.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Investigation, Case, CaseParticipant

listInvestigationDeliveryActionPlan

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ICInvestigationDeliveryActionPlanList listInvestigationDeliveryActionPlan(curam.core.sl.entity.struct.LinkKey key)
                                                                                                                         throws curam.util.exception.AppException,
                                                                                                                                curam.util.exception.InformationalException

Returns a list of action plans for an investigation on an integrated case.

Parameters:

key - The investigation id.

Returns:

A list of action plans.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

ActionPlan

listInvestigationDeliveryAllegation

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

Returns a list of allegations for an investigation on an integrated case.

Parameters:

key - The investigation id.

Returns:

A list of allegations.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Allegation

listInvestigationDeliveryAssessment

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

Returns a list of assessments for an investigation on an integrated case.

Parameters:

key - The investigation id.

Returns:

A list of assessments.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Assessment

listInvestigationDeliveryAttachment

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

Returns a list of attachments for an investigation on an integrated case.

Parameters:

key - The investigation id.

Returns:

A list of attachments.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Attachment

listInvestigationDeliveryCaseMember

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

Returns a list of investigation case members.

Parameters:

The - investigation id.

Returns:

A list of investigation case members.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

CaseParticipant

listInvestigationDeliveryClientRole

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

Returns a list of investigation case participants with their client roles.

Parameters:

key - The investigation id.

Returns:

A list of investigation client roles.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Case, CaseParticipant

listInvestigationDeliveryMilestone

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

Returns a list of milestones for an investigation on an integrated case.

Parameters:

The - investigation id.

Returns:

A list of milestones.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Milestone

listInvestigationDeliveryRelatedCase

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

Returns a list of related cases for an investigation on an integrated case.

Parameters:

key - The investigation id.

Returns:

A list of related cases.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

CaseRelationship

listInvestigationDeliveryTask

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

Returns a list of tasks for an investigation on an integrated case.

Parameters:

key - The integrated case id.

Returns:

A list of tasks.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Case, Task

listInvestigationDeliveryUserRole

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

Returns a list of user roles for an investigation on an integrated case.

Parameters:

key - The investigation id.

Returns:

A list of user roles.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Case, CaseUserRole

listInvestigationUncompletedMilestone

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

Returns a list of uncompleted milestones for an investigation on an integrated case.

Parameters:

key - The investigation id

Returns:

A list of uncompleted milestones.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Milestone, ProductDelivery

listIssue

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.IssueCaseDtlsList listIssue(curam.core.struct.CaseHeaderKey caseHeaderKey)
                                                                           throws curam.util.exception.AppException,
                                                                                  curam.util.exception.InformationalException

Return a list all the issues on an integrated case.

Parameters:

caseHeaderKey - The integrated case id.

Returns:

A list of issues.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Case, Issue

listMemberActivity

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListMemberActivityDetails listMemberActivity(curam.core.facade.struct.CaseParticipantRoleKey key)
                                                                                            throws curam.util.exception.AppException,
                                                                                                   curam.util.exception.InformationalException

Returns a list of activities for a member of an integrated case.

Parameters:

The - member id.

Returns:

A list of member activities.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Activity, ActivityAttendee, CaseParticipant, Case

listMemberAndContractTemplate

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListMemberAndContractTemplateDetails listMemberAndContractTemplate(curam.core.facade.struct.ListMemberAndContractTemplateKey key)
                                                                                                                  throws curam.util.exception.AppException,
                                                                                                                         curam.util.exception.InformationalException

Returns a list of members for the integrated case and a list of case contract templates.

Parameters:

The - integrated case id

Returns:

A list of members and contract templates.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Case, CaseParticipant, ContractTemplate

listMemberAssessment

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListICMemberAssessmentDetails listMemberAssessment(curam.core.facade.struct.CaseParticipantRoleKey key)
                                                                                                  throws curam.util.exception.AppException,
                                                                                                         curam.util.exception.InformationalException

Returns a list of assessments for a member on an integrated case.

Parameters:

The - case participant id.

Returns:

A list of assessments.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

CaseParticipant, Case, Assessment

listMemberContract

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListMemberContractDetails listMemberContract(curam.core.facade.struct.CaseParticipantRoleKey key)
                                                                                            throws curam.util.exception.AppException,
                                                                                                   curam.util.exception.InformationalException

Returns a list of contracts for a member on an integrated case.

Parameters:

The - case participant id.

Returns:

A list of contracts.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Case, CaseParticipant, CaseContract

listMemberContractDetails

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListMemberAndContractTemplateDetails listMemberContractDetails(curam.core.facade.struct.CaseParticipantRoleKey key)
                                                                                                              throws curam.util.exception.AppException,
                                                                                                                     curam.util.exception.InformationalException

Returns a list of contracts for case member on an integrated case.

Parameters:

The - case participant id.

Returns:

A list of contracts.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

CaseParticipant, CaseContract

listMemberDetails

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListMemberDetails listMemberDetails(curam.core.facade.struct.ListMemberDetailsKey key)
                                                                                   throws curam.util.exception.AppException,
                                                                                          curam.util.exception.InformationalException

Returns a list of members on an integrated case.

Parameters:

The - integrated case id.

Returns:

A list of case members.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

CaseParticipant, ConcernRole, SpecialCaution

listMemberFinancial

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListMemberFinancialDetails listMemberFinancial(curam.core.facade.struct.CaseParticipantRoleKey key)
                                                                                              throws curam.util.exception.AppException,
                                                                                                     curam.util.exception.InformationalException

Returns a list of financials for a member on an integrated case.

Parameters:

The - case participant id.

Returns:

A list of financials.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

CaseParticipant, Case, ConcernRole, Address, FinancialInstruction, InstructionLineItem

listMemberIssue

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.IssueDeliveryForICMemberDtlsList listMemberIssue(curam.core.sl.entity.struct.CaseParticipantRoleKey caseParticipantRoleKey)
                                                                                                throws curam.util.exception.AppException,
                                                                                                       curam.util.exception.InformationalException

Returns a list of issues for a case participant on an integrated case.

Parameters:

The - case participant id.

Returns:

A list of issues.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Case, CaseParticipant, Issue

listMemberProduct

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListICMemberProductDeliveryDetails listMemberProduct(curam.core.facade.struct.CaseParticipantRoleKey key)
                                                                                                    throws curam.util.exception.AppException,
                                                                                                           curam.util.exception.InformationalException

Returns a list of product deliveries for an integrated case member.

Parameters:

The - case participant id.

Returns:

A list of product deliveries.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

CaseParticipant, ProductDelivery, CaseUserRole

listMemberTasks

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListMemberTaskDetails listMemberTasks(curam.core.facade.struct.CaseParticipantRoleKey key)
                                                                                     throws curam.util.exception.AppException,
                                                                                            curam.util.exception.InformationalException

Returns a list of tasks assigned to a member of an integrated case.

Parameters:

The - case participant id.

Returns:

A list of tasks.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

CaseParticipant, Case, Task

listProduct

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListICProductDeliveryDetails listProduct(curam.core.facade.struct.IntegratedCaseIDKey key)
                                                                                        throws curam.util.exception.AppException,
                                                                                               curam.util.exception.InformationalException

Returns a list of products deliveries on an integrated case.

Parameters:

The - integrated case id.

Returns:

A list of product deliveries.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Case, CaseParticipant, ConcernRole

listProductDeliveryAdminCaseRole

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListICProductDeliveryAdminCaseRole listProductDeliveryAdminCaseRole(curam.core.facade.struct.ListICProductDeliveryAdminCaseRoleKey key)
                                                                                                                   throws curam.util.exception.AppException,
                                                                                                                          curam.util.exception.InformationalException

Returns a list of administration user roles for a product delivery on an integrated case.

Parameters:

key - The product delivery id.

Returns:

A list of administration user roles.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

CaseUserRole

listProductDeliveryAppliedUnappliedDeduction

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListICProductDeliveryDeductionDetails listProductDeliveryAppliedUnappliedDeduction(curam.core.facade.struct.ListICProductDeliveryDeductionKey key)
                                                                                                                                  throws curam.util.exception.AppException,
                                                                                                                                         curam.util.exception.InformationalException

Returns a list of applied and un-applied deductions for a product delivery.

Parameters:

key - The product delivery id.

Returns:

A list of deductions.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Case, Deduction

listProductDeliveryAttachment

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListICProductDeliveryAttachmentDetails listProductDeliveryAttachment(curam.core.facade.struct.ListICProductDeliveryAttachmentKey key)
                                                                                                                    throws curam.util.exception.AppException,
                                                                                                                           curam.util.exception.InformationalException

Returns a list of attachments for a product delivery on an integrated case.

Parameters:

key - The product delivery id.

Returns:

A list of attachments.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Attachment

listProductDeliveryCaseRelationship

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListICProductDeliveryCaseRelationship listProductDeliveryCaseRelationship(curam.core.facade.struct.ListICProductDeliveryCaseRelationshipKey key)
                                                                                                                         throws curam.util.exception.AppException,
                                                                                                                                curam.util.exception.InformationalException

Returns a list of related cases to a product delivery.

Parameters:

key - The product delivery id.

Returns:

A list of cases.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Case, CaseRelationship

listProductDeliveryClientRole

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListICProductDeliveryClientRoleDetails listProductDeliveryClientRole(curam.core.facade.struct.ListICProductDeliveryClientRoleKey key)
                                                                                                                    throws curam.util.exception.AppException,
                                                                                                                           curam.util.exception.InformationalException

Returns a list of client roles for a product delivery on an integrated case.

Parameters:

key - The product delivery id.

Returns:

A list of client roles.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Case, CaseParticipant, ConcernRole, SpecialCaution

listProductDeliveryDecision

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListICProductDeliveryDecision listProductDeliveryDecision(curam.core.facade.struct.ListICProductDeliveryDecisionKey key)
                                                                                                         throws curam.util.exception.AppException,
                                                                                                                curam.util.exception.InformationalException

Returns a list of product delivery case decisions on an integrated case.

Parameters:

key - The product delivery id.

Returns:

A list of product delivery decisions.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Case, CaseDecision

listProductDeliveryEvidence

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListICProductDeliveryEvidenceDetails listProductDeliveryEvidence(curam.core.facade.struct.ListICProductDeliveryEvidenceKey key)
                                                                                                                throws curam.util.exception.AppException,
                                                                                                                       curam.util.exception.InformationalException

Returns a list of evidence for a product delivery on an integrated case.

Parameters:

key - The product delivery id.

Returns:

A list of evidence.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Evidence

listProductDeliveryFinancial

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListICProductDeliveryFinancialDetails listProductDeliveryFinancial(curam.core.facade.struct.ListICProductDeliveryFinancialsKey key)
                                                                                                                  throws curam.util.exception.AppException,
                                                                                                                         curam.util.exception.InformationalException

Returns a list of financials for a product delivery on an integrated Case.

Parameters:

key - The product delivery id.

Returns:

A list of financials.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

ProductDelivery, InstructionLineItem, ConcernRole

listProductDeliveryFinInstruction

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListICProductDeliveryInstructionDetails listProductDeliveryFinInstruction(curam.core.facade.struct.ListICProductDeliveryFinancialsKey key)
                                                                                                                         throws curam.util.exception.AppException,
                                                                                                                                curam.util.exception.InformationalException

Returns a list of financials for a product delivery on an integrated case.

Parameters:

key - The product delivery id.

Returns:

A list of product deliveries.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

InstructionLineItem, FinancialInstruction, CaseNominee

listProductDeliveryInfoDetailsForCase

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListDeliveryPatternHistoryDetails listProductDeliveryInfoDetailsForCase(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 product delivery.

Parameters:

key - The product delivery id.

Returns:

A list of product delivery patterns.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

CaseNominee, ProductDelivery, ProductDeliveryPattern

listProductDeliveryIssue

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.IssueCaseDtlsList listProductDeliveryIssue(curam.core.struct.CaseHeaderKey caseHeaderKey)
                                                                                          throws curam.util.exception.AppException,
                                                                                                 curam.util.exception.InformationalException

Returns a list of issues for a product delivery.

Parameters:

caseHeaderKey - The product delivery id.

Returns:

A list of issues.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Issue, Case, CaseParticipant

listProductDeliveryOverUnderPayment

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListICProductDeliveryOverUnderPaymentDetails listProductDeliveryOverUnderPayment(curam.core.facade.struct.ListICProductDeliveryOverUnderPaymentKey key)
                                                                                                                                throws curam.util.exception.AppException,
                                                                                                                                       curam.util.exception.InformationalException

Returns a list of over payment cases and under payment cases on an integrated case product delivery.

Parameters:

The - product delivery id.

Returns:

A list of over payments and under payments.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

ProductDelivery

listProductDeliveryRecentTransaction

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListTransactionsLogDetails listProductDeliveryRecentTransaction(curam.core.struct.CaseHeaderKey caseHeaderKey)
                                                                                                               throws curam.util.exception.AppException,
                                                                                                                      curam.util.exception.InformationalException

Returns a list of the recent transactions on a product delivery.

Parameters:

caseKey - The product delivery id.

Returns:

A list of recent transactions.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

CaseTransaction

listProductDeliveryTask

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListICProductDeliveryTaskDetails listProductDeliveryTask(curam.core.facade.struct.ListICProductDeliveryTaskKey_eo key)
                                                                                                        throws curam.util.exception.AppException,
                                                                                                               curam.util.exception.InformationalException

Returns a list of tasks for a product delivery on an integrated case.

Parameters:

key - The product delivery id.

Returns:

A list of tasks.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

ProductDelivery, Task

listProductDeliveryThirdPartyDeduction

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListICProductDeliveryDeductionDetails listProductDeliveryThirdPartyDeduction(curam.core.facade.struct.ListICProductDeliveryDeductionKey key)
                                                                                                                            throws curam.util.exception.AppException,
                                                                                                                                   curam.util.exception.InformationalException

Returns a list of third party deductions on a product delivery.

Parameters:

key - The product delivery id.

Returns:

A list of third party deductions.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

ProductDelivery, Deduction

listProductDeliveryUtilityPayment

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListICProductDeliveryUtility listProductDeliveryUtilityPayment(curam.core.facade.struct.ListICProductDeliveryUtilityKey key)
                                                                                                              throws curam.util.exception.AppException,
                                                                                                                     curam.util.exception.InformationalException

Returns a list of utility payments for a product delivery.

Parameters:

key - The product delivery id.

Returns:

A list of utility payments.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

ProductDelivery, Assessment, HouseholdBudgetItem, Utility

listProductsForCategory

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListProductsForCategoryDetails listProductsForCategory(curam.core.facade.struct.CaseParticipantRoleKey key)
                                                                                                      throws curam.util.exception.AppException,
                                                                                                             curam.util.exception.InformationalException

Returns a list of products in a particular category for a case participant's case type.

Parameters:

key - The case particpant id.

Returns:

A list of products.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

ProductDelivery, CaseParticipant, Product, ProductCategory

listRecentTransaction

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListTransactionsLogDetails listRecentTransaction(curam.core.struct.CaseHeaderKey caseKey)
                                                                                                throws curam.util.exception.AppException,
                                                                                                       curam.util.exception.InformationalException

Returns a list of the recent transactions on a case.

Parameters:

caseKey - The case id.

Returns:

A list of recent case transactions.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

CaseTransaction

listSpecialCaution

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.SpecialCautionsList listSpecialCaution(curam.core.facade.struct.CaseParticipantRoleKey key)
                                                                                      throws curam.util.exception.AppException,
                                                                                             curam.util.exception.InformationalException

Returns a list of the special cautions for a case participant.

Parameters:

key - The case participant id.

Returns:

A list of special cautions.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

CaseParticipant, SpecialCaution

listSpecialCautionHistory

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.SpecialCautionsList listSpecialCautionHistory(curam.core.facade.struct.CaseParticipantRoleKey key)
                                                                                             throws curam.util.exception.AppException,
                                                                                                    curam.util.exception.InformationalException

Returns a list of the special cautions for a case member that have been cancelled or have end dates that have passed.

Returns:

A list of special cautions.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

CaseParticipant, SpecialCaution

listTask

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListICTaskDetails listTask(curam.core.facade.struct.ListICTaskKey_eo key)
                                                                          throws curam.util.exception.AppException,
                                                                                 curam.util.exception.InformationalException

Returns a list of tasks on an integrated case.

Parameters:

key - The integrated case id.

Returns:

A list of tasks.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Case, Task

listTasksDueDuringContractPeriod

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListTasksDueDuringContractPeriod listTasksDueDuringContractPeriod(curam.core.facade.struct.ListTasksDueKey key)
                                                                                                                 throws curam.util.exception.AppException,
                                                                                                                        curam.util.exception.InformationalException

Returns a list of tasks due over a contract's period.

Parameters:

key - The contract id.

Returns:

A list of tasks.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

CaseContract, Task

modifyCaseDetails

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

Modifies an integrated case's details.

Parameters:

details - The integrated cases details.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Case

Business Object Write:

Case

modifyContract

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

Modifies the details of a contract on an integrated case.

Parameters:

details - The modified contract details.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

CaseContract

Business Object Write:

CaseContract

printContract

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

Prints a contract.

Parameters:

details - The contract details.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

CaseContract

readContractDetails

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadContractDetails readContractDetails(curam.core.facade.struct.ReadCaseContractKey key)
                                                                                       throws curam.util.exception.AppException,
                                                                                              curam.util.exception.InformationalException

Reads details for a contract and also tasks due on an integrated case.

Parameters:

The - contract id.

Returns:

The contract details and a list of tasks.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

CaseContract, ConcernRole

readEmployerDetails

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadICEmployerDetails readEmployerDetails(curam.core.facade.struct.CaseParticipantRoleKey key)
                                                                                         throws curam.util.exception.AppException,
                                                                                                curam.util.exception.InformationalException

Reads the details for an employer case participant on an integrated case.

Parameters:

key - The case participant id.

Returns:

The employer details.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

CaseParticipant, Employer

readInformationProviderDetails

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadICInformationProviderDetails readInformationProviderDetails(curam.core.facade.struct.CaseParticipantRoleKey key)
                                                                                                               throws curam.util.exception.AppException,
                                                                                                                      curam.util.exception.InformationalException

Reads the details for an information provider case participant on an integrated case.

Parameters:

key - The case participant id.

Returns:

The information provider's details.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

CaseParticipant, InformationProvider

readMemberDetails

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadICMemberDetails readMemberDetails(curam.core.facade.struct.CaseParticipantRoleKey key)
                                                                                     throws curam.util.exception.AppException,
                                                                                            curam.util.exception.InformationalException

Reads the details for a member of an integrated case.

Parameters:

key - The case participant id.

Returns:

The case member's details.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

CaseParticipant, Case, ConcernRole

searchInvestigationEventAndActivity1

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ICInvestigationEventAndActivityDetails1 searchInvestigationEventAndActivity1(curam.core.facade.struct.SearchCaseEventAndActivityKey key)
                                                                                                                            throws curam.util.exception.AppException,
                                                                                                                                   curam.util.exception.InformationalException

Returns case events and activities from a specified start date for an investigation calendar.

Parameters:

key - The investigation id.

Returns:

Data representing case events and activities.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Investigation, CaseEvent, CaseDecision

readPersonDetails

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadICPersonDetails readPersonDetails(curam.core.facade.struct.CaseParticipantRoleKey key)
                                                                                     throws curam.util.exception.AppException,
                                                                                            curam.util.exception.InformationalException

Reads the details for a person case participant on an integrated case.

Parameters:

key - The case participant id.

Returns:

The person details.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

CaseParticipant, Person

readProductProviderDetails

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadICProductProviderDetails readProductProviderDetails(curam.core.facade.struct.CaseParticipantRoleKey key)
                                                                                                       throws curam.util.exception.AppException,
                                                                                                              curam.util.exception.InformationalException

Reads the details for a product provider case participant on an integrated case.

Parameters:

The - case participant id.

Returns:

The product provider details.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

CaseParticipant, ProductProvider

readProspectPersonDetails

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadICPersonDetails readProspectPersonDetails(curam.core.facade.struct.CaseParticipantRoleKey key)
                                                                                             throws curam.util.exception.AppException,
                                                                                                    curam.util.exception.InformationalException

Returns the details for a prospect person case participant on an integrated case.

Parameters:

The - case participant id.

Returns:

The prospect person details.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

CaseParticipant, ProspectPerson

readRepresentativeDetails

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadICRepresentativeDetails readRepresentativeDetails(curam.core.facade.struct.CaseParticipantRoleKey key)
                                                                                                     throws curam.util.exception.AppException,
                                                                                                            curam.util.exception.InformationalException

Returns the details for a representative case participant on an integrated case.

Parameters:

key - The case participant id.

Returns:

The representative details.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

CaseParticipant, Representative

readServiceSupplierDetails

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadICServiceSupplierDetails readServiceSupplierDetails(curam.core.facade.struct.CaseParticipantRoleKey key)
                                                                                                       throws curam.util.exception.AppException,
                                                                                                              curam.util.exception.InformationalException

Reads the details for a service supplier case participant on an integrated case.

Parameters:

The - case participant id.

Returns:

The service supplier details.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

CaseParticipant, ServiceSupplier

readUtilityDetails

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadICUtilityDetails readUtilityDetails(curam.core.facade.struct.CaseParticipantRoleKey key)
                                                                                       throws curam.util.exception.AppException,
                                                                                              curam.util.exception.InformationalException

Reads the details for a utility case participant on an integrated case.

Parameters:

The - case participant

Returns:

The utility details.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

CaseParticipant, Utility

removeTaskFromContract

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

Cancels a task from a contract on an integrated case.

Parameters:

The - task id.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

CaseContract

resolveCaseHome

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ResolveHomePageDetails resolveCaseHome(curam.core.facade.struct.ResolveHomePageKey key)
                                                                                      throws curam.util.exception.AppException,
                                                                                             curam.util.exception.InformationalException

Return the home page name for an integrated case.

Parameters:

The - integrated case id.

Returns:

The integrated case's home page.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Case

resolveMemberHome

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.MemberHomePageName resolveMemberHome(curam.core.facade.struct.IntegratedCaseIDKey key)
                                                                                    throws curam.util.exception.AppException,
                                                                                           curam.util.exception.InformationalException

Returns the home page name for case members on an integrated case.

Parameters:

key - The integrated case.

Returns:

The case member home page.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Case

resolveParticipantHome

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ParticipantHomePageName resolveParticipantHome(curam.core.facade.struct.CaseParticipantRoleIDKey key)
                                                                                              throws curam.util.exception.AppException,
                                                                                                     curam.util.exception.InformationalException

Returns the home page name for participants on an integrated case

Parameters:

key - The case participant id.

Returns:

The case participant home page.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

CaseParticipant

searchICMemberActivity

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ICMemberActivityDetails searchICMemberActivity(curam.core.facade.struct.SearchICMemberActivityKey key)
                                                                                              throws curam.util.exception.AppException,
                                                                                                     curam.util.exception.InformationalException

Returns case activities for a case member on an integrated case.

Parameters:

key - The case participant id.

Returns:

Data representing a case members activities.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Activity, Case, CaseParticipant

listCurrentProductDeliveryDeduction

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.CurrentDeductionsForProductDeliveryList listCurrentProductDeliveryDeduction(curam.core.facade.struct.ListICProductDeliveryDeductionKey key)
                                                                                                                           throws curam.util.exception.AppException,
                                                                                                                                  curam.util.exception.InformationalException

Returns a list of the current deductions for an integrated case product delivery.

Parameters:

key - The integrated case id.

Returns:

A list of the current deductions.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Deduction

listProductDeliveryDeductionHistory

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListICProductDeliveryDeductionDetails listProductDeliveryDeductionHistory(curam.core.facade.struct.ListICProductDeliveryDeductionKey key)
                                                                                                                         throws curam.util.exception.AppException,
                                                                                                                                curam.util.exception.InformationalException

Returns a list of deductions for a product delivery that are not current.

Parameters:

key - The case id.

Returns:

A list of deductions.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Case, Deduction

listProductDeliveryStatusHistory1

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListICProductDeliveryStatusHistory1 listProductDeliveryStatusHistory1(curam.core.facade.struct.ListICProductDeliveryStatusHistoryKey key)
                                                                                                                     throws curam.util.exception.AppException,
                                                                                                                            curam.util.exception.InformationalException

Returns the status history for a product delivery within an integrated case.

Parameters:

key - The product delivery id.

Returns:

A history of statuses.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

ProductDelivery, CaseStatus

listInvestigationDeliveryStatusHistory1

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

Returns a status history list for an investigation on an integrated case.

Parameters:

key - The investigation id.

Returns:

A status history list.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Case, CaseStatus

countActiveTasks

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

Returns a count of the active tasks on a case. If the count is greater than zero an informational will be displayed.

Parameters:

caseKey - The case id.

Returns:

An informational message to tell the user if there are active tasks.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Task

searchICProductDeliveryEventAndActivity1

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ICProductDeliveryEventAndActivityDetails1 searchICProductDeliveryEventAndActivity1(curam.core.facade.struct.SearchCaseEventAndActivityKey key)
                                                                                                                                  throws curam.util.exception.AppException,
                                                                                                                                         curam.util.exception.InformationalException

Returns case events and activities from a specified start date for a product delivery calendar.

Parameters:

key - The product delivery id.

Returns:

Data representing case events and activities.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

ProductDelivery, CaseEvent, Activity, CaseDecision

searchICCaseEventAndActivity1

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ICCaseEventAndActivityDetails1 searchICCaseEventAndActivity1(curam.core.facade.struct.SearchCaseEventAndActivityKey key)
                                                                                                            throws curam.util.exception.AppException,
                                                                                                                   curam.util.exception.InformationalException

Returns case events and activities from a specified start date for an integrated case calendar.

Parameters:

key - The integrated case id and start date.

Returns:

Data representing case events and activities.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Case, CaseEvent, Activity

listInvestigationDeliveryContactLog1

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

Returns a list of contact logs for an investigation on an integrated case.

Parameters:

key - The investigation id.

Returns:

A list of contact logs.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

ContactLog

getCaseParticipantsAgeConcernRoleID

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListMemberDetails getCaseParticipantsAgeConcernRoleID(curam.core.facade.struct.CaseID caseID)
                                                                                                     throws curam.util.exception.AppException,
                                                                                                            curam.util.exception.InformationalException

Lists the name, age and concern role id for the case participants on an integrated case.

Parameters:

caseID - The integrated case id.

Returns:

List of case participants.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

CaseParticipant, Case, ConcernRole

listProductDeliveryNominee1

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.CaseNomineeDetailsWithVersionNoList listProductDeliveryNominee1(curam.core.facade.struct.ListICProductDeliveryNomineeKey key)
                                                                                                               throws curam.util.exception.AppException,
                                                                                                                      curam.util.exception.InformationalException

Returns a list of nominees for a product delivery on an integrated case.

Parameters:

key - The product delivery id.

Returns:

A list of nominees.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

ProductDelivery, CaseNominee, CaseParticipant

listCurrentDeliveryPattern

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

lists all current delivery pattern details for a case.

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

listProductDeliveryObjectiveAndDelPatt

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListICProductDeliveryObjectiveAndDelPatt listProductDeliveryObjectiveAndDelPatt(curam.core.facade.struct.ListObjectiveKey key)
                                                                                                                               throws curam.util.exception.AppException,
                                                                                                                                      curam.util.exception.InformationalException

Returns a list of objectives available on a product delivery. For each objective the current delivery pattern is returned.

Parameters:

key - The product delivery id.

Returns:

A list of objectives.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

CaseNominee, CaseNomineeObjective, ProductDeliveryPattern

createIntegratedCase1

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.CreateIntegratedCaseResult createIntegratedCase1(curam.core.facade.struct.CreateIntegratedCaseDetails1 details)
                                                                                                throws curam.util.exception.AppException,
                                                                                                       curam.util.exception.InformationalException

Creates an integrated case.

Parameters:

details - The details of the integrated case.

Returns:

The integrated case id and home page name

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

Case, CaseUserRole, CaseParticipant, CaseStatus, CaseRelationship

readTranslationRequiredInd

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

Reads the primary case participant's details including if they need a translator for an integrated case.

Parameters:

key - The integrated case id.

Returns:

The case participant's details.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

CaseParticipant

listProductDeliveryEvent1

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListICProductDeliveryEventDetails1 listProductDeliveryEvent1(curam.core.facade.struct.ListICProductDeliveryEventKey key)
                                                                                                            throws curam.util.exception.AppException,
                                                                                                                   curam.util.exception.InformationalException

Returns a list of events for a product delivery on an integrated case.

Parameters:

The - product delivery id.

Returns:

A list of events.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Case, CaseEvent, Activity, Milestone, CaseDecision

listEvent1

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

Returns a list of events on an integrated case.

Parameters:

A - list of active events.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Case, CaseEvent, Activity, MeetingMinutes, Milestone

listInvestigationDeliveryEvent1

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

Returns a list of events for an investigation delivery on an integrated case.

Parameters:

key - The investigation id.

Returns:

A list of events.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Case, CaseEvent, Activity, MeetingMinutes, Milestone

readTranslatorRequiredForMember

@AccessLevel(value=EXTERNAL)
curam.core.sl.struct.CaseParticipantRoleDtlsList readTranslatorRequiredForMember(curam.core.facade.struct.IntegratedCaseIDKey key)
                                                                                                       throws curam.util.exception.AppException,
                                                                                                              curam.util.exception.InformationalException

Returns a list of case members details including if they need a translator for an integrated case.

Parameters:

The - integrated case id.

Returns:

A list of case members.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

CaseParticipant

listProductDeliveryCertificationAndVersionNo

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

Returns a list of certifications on a product delivery.

Parameters:

key - The product delivery id.

Returns:

A list of certification details.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Certification

listProductDeliveryCertification1

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

Returns a list of certifications on a product delivery.

Parameters:

The - product delivery id.

Returns:

A list of certifications.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Certification

readCaseDetails1

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadIntegratedCaseDetails1 readCaseDetails1(curam.core.facade.struct.IntegratedCaseIDKey key)
                                                                                           throws curam.util.exception.AppException,
                                                                                                  curam.util.exception.InformationalException

Reads the details of an integrated case.

Parameters:

key - The integrated case id.

Returns:

The integrated case details.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Case, CaseParticipant, ConcernRole

Business Object Write:

UserRecentAction

readICProductHomePageDetails1

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadICProductHomePageDetails1 readICProductHomePageDetails1(curam.core.facade.struct.ReadICProductHomePageKey key)
                                                                                                           throws curam.util.exception.AppException,
                                                                                                                  curam.util.exception.InformationalException

Reads the home page details for a product on an integrated case.

Parameters:

key - The product delivery id.

Returns:

The product delivery details.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

ProductDelivery, CaseParticipant, CaseUserRole, CaseNominee, CaseNomineeProductDeliveryPattern, ProductDeliveryPattern, Product, CaseEvent

readICBenefitUnderpmtHomePageDetails1

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ICBenefitUnderpmtHomePageDetails1 readICBenefitUnderpmtHomePageDetails1(curam.core.facade.struct.ReadICProductHomePageKey key)
                                                                                                                       throws curam.util.exception.AppException,
                                                                                                                              curam.util.exception.InformationalException

Reads details to populate an integrated case benefit underpayment home page.

Parameters:

key - The benefit underpayment id.

Returns:

The benefit underpayment details.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Case, ProductDelivery, CaseParticipant, Evidence

Business Object Write:

UserRecentAction

listCaseMemberCommunication

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.CommunicationDetailList listCaseMemberCommunication(curam.core.facade.struct.CaseParticipantRoleKey key)
                                                                                                   throws curam.util.exception.AppException,
                                                                                                          curam.util.exception.InformationalException

Returns a list of communications for a case member.

Parameters:

communicationKey - The concern role id and case id.

Returns:

A list of communications.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Communication, Attachment

listSpecialCautionHistoryForCase

@AccessLevel(value=EXTERNAL)
curam.core.sl.struct.CaseSpecialCautionDetailsList listSpecialCautionHistoryForCase(curam.core.struct.CaseID key)
                                                                                                          throws curam.util.exception.AppException,
                                                                                                                 curam.util.exception.InformationalException

Returns a list of the special cautions for a case that have been cancelled or have end dates that have passed.

Parameters:

key - The case id.

Returns:

A list of special cautions.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

CaseParticipant, SpecialCaution

listSpecialCautionsForCase

@AccessLevel(value=EXTERNAL)
curam.core.sl.struct.CaseSpecialCautionDetailsList listSpecialCautionsForCase(curam.core.struct.CaseID key)
                                                                                                    throws curam.util.exception.AppException,
                                                                                                           curam.util.exception.InformationalException

Returns a list of special cautions for case members on a case.

Parameters:

key - The case id.

Returns:

A list of special cautions.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

CaseParticipant, SpecialCaution

listCaseMembers1

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListICClientRoleDetails1 listCaseMembers1(curam.core.facade.struct.ListICClientKey key)
                                                                                         throws curam.util.exception.AppException,
                                                                                                curam.util.exception.InformationalException

Returns a list of case members for a case.

Parameters:

key - The case id.

Returns:

A list of case members.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Case, CaseParticipant

createIntegratedCaseAndRegisterPerson

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.CreateIntegratedCaseResultAndMessages createIntegratedCaseAndRegisterPerson(curam.core.facade.struct.CreateICAndRegisterPerson details)
                                                                                                                           throws curam.util.exception.AppException,
                                                                                                                                  curam.util.exception.InformationalException

Creates an integrated case and registers a person. The registered person becomes the primary member on the case.

Parameters:

createICAndRegisterPerson - The details of the person and the integrated case being created.

Returns:

The case id and home page name

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

Case, CaseUserRole, CaseParticipant, CaseStatus, CaseRelationship, Person

createIntegratedCaseAndRegisterProspectPerson

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.CreateIntegratedCaseResultAndMessages createIntegratedCaseAndRegisterProspectPerson(curam.core.facade.struct.CreateICAndRegisterProspectPerson details)
                                                                                                                                   throws curam.util.exception.AppException,
                                                                                                                                          curam.util.exception.InformationalException

Creates an integrated case and registers a prospect person.

Parameters:

createICAndRegisterProspectPerson - The details of the person and the integrated case being created.

Returns:

The integrated case id and home page name.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

Case, CaseUserRole, CaseParticipant, CaseStatus, CaseRelationship, ProspectPerson

listAccessibleNote1

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListICAccessibleNoteDetails1 listAccessibleNote1(curam.core.facade.struct.ListICNotesKey key)
                                                                                                throws curam.util.exception.AppException,
                                                                                                       curam.util.exception.InformationalException

Returns a list of accessible notes on an integrated case. The list comprises of notes with an indicator to restrict access to view and edit the note details.

Parameters:

key - The integrated case id.

Returns:

A list of accessible notes.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Note

listMemberNote1

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListMemberNoteDetails1 listMemberNote1(curam.core.facade.struct.CaseParticipantRoleKey key)
                                                                                      throws curam.util.exception.AppException,
                                                                                             curam.util.exception.InformationalException

Returns a list of notes relating to a member of an integrated case.

Parameters:

The - case participant id.

Returns:

A list of notes.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Case, Note

readMemberNote1

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadMemberNoteDetails1 readMemberNote1(curam.core.facade.struct.ReadMemberNoteKey key)
                                                                                      throws curam.util.exception.AppException,
                                                                                             curam.util.exception.InformationalException

Reads the details of a member note on an integrated case.

Parameters:

key - The note id.

Returns:

The note details.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Note

createMemberNote1

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

Creates an integrated case member note.

Parameters:

details - The integrated case member note details.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

Note

modifyMemberNote1

@AccessLevel(value=EXTERNAL)
void modifyMemberNote1(curam.core.facade.struct.ModifyMemberNoteDetailsKey key,
                                                    curam.core.facade.struct.ModifyMemberNoteDetails1 details)
                                             throws curam.util.exception.AppException,
                                                    curam.util.exception.InformationalException

Modifies the details of an integrated case member note.

Parameters:

details - The note details.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

Note

listInvestigationDeliveryNote1

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

Returns a list of notes for an investigation on an integrated case.

Parameters:

key - The investigation id.

Returns:

A list of notes.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Note

listPDAccessibleNote1

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListICPDAccessibleNoteDetails1 listPDAccessibleNote1(curam.core.facade.struct.ListICProductDeliveryNoteKey key)
                                                                                                    throws curam.util.exception.AppException,
                                                                                                           curam.util.exception.InformationalException

Returns a list of accessible notes on a product delivery. It performs a check of note sensitivity and user's sensitivity and sets a note access indicator to true, if user sensitivity is less than the note sensitivity.

Parameters:

key - The product delivery id.

Returns:

A list of notes.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Note

readCaseIDandParticipantRoleIDDetails

@AccessLevel(value=EXTERNAL)
curam.core.sl.entity.struct.CaseIDAndParticipantRoleIDDetails readCaseIDandParticipantRoleIDDetails(curam.core.facade.struct.CaseParticipantRoleKey key)
                                                                                                                          throws curam.util.exception.AppException,
                                                                                                                                 curam.util.exception.InformationalException

Reads the case id and participant role id for a case particpant.

Parameters:

key - The case participant id.

Returns:

The case id and participant role id.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

CaseParticipant

readCaseDetails2

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadIntegratedCaseDetails1 readCaseDetails2(curam.core.facade.struct.IntegratedCaseIDKey key)
                                                                                           throws curam.util.exception.AppException,
                                                                                                  curam.util.exception.InformationalException

Reads the details of an integrated case.

Parameters:

key - The case id.

Returns:

The integrated case's details.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Case, CaseParticipant, ConcernRole, CaseStatus

Business Object Write:

UserRecentAction

listLiabilityProduct

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListICProductDeliveryDetails listLiabilityProduct(curam.core.facade.struct.IntegratedCaseIDKey key)
                                                                                                 throws curam.util.exception.AppException,
                                                                                                        curam.util.exception.InformationalException

Returns a list of liability cases on an integrated case.

Parameters:

key - The integrated case id.

Returns:

A list of liability cases.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Case, CaseParticipant, ConcernRole

listActiveCaseMembersForCommunicationsFilter

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

Returns a list of active case members.

Parameters:

key - The integrated case id.

Returns:

A list of active case members.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

CaseParticipant, Case, ConcernRole

listFilteredCommunication
```
@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.CommunicationDetailList listFilteredCommunication(curam.core.facade.struct.CommunicationFilterKey key)
                                                                                                 throws curam.util.exception.AppException,
                                                                                                        curam.util.exception.InformationalException
```
Returns a list of communications for the primary client (even if they are not the correspondent) or a specified case member. An 'All' option is also available. This displays all of the communications for the integrated case.

Parameters:

key - The integrated case id, concern role id and concern role name to filter the list by.

Returns:

A list of communications.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:
Communication, Attachment

listDeductionCaseParticipantWithoutProspect

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListMemberDetails listDeductionCaseParticipantWithoutProspect(curam.core.facade.struct.ListMemberDetailsKey key)
                                                                                                             throws curam.util.exception.AppException,
                                                                                                                    curam.util.exception.InformationalException

Returns a list of case participants used in deductions creation. Excludes prospect persons and prospect employers.

Parameters:

key - The integrated case id.

Returns:

A list of case participants.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Case, CaseParticipant

readConcernRoleID

@AccessLevel(value=EXTERNAL)
curam.core.struct.ConcernRoleID readConcernRoleID(curam.core.facade.struct.CaseParticipantRoleKey key)
                                                                        throws curam.util.exception.AppException,
                                                                               curam.util.exception.InformationalException

Reads the concern role id for a member of an integrated case.

Parameters:

key - The case participant id.

Returns:

The concern role id.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

ConcernRole

reopenCase

@AccessLevel(value=EXTERNAL)
void reopenCase(curam.core.facade.struct.ReactivationDetails reactivationDetails)
                                      throws curam.util.exception.AppException,
                                             curam.util.exception.InformationalException

Reopens a closed integrated case.

Parameters:

The - details to reopen the case with.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

Case, CaseStatus

listCaseParticipantsWithAge

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListMemberDetails listCaseParticipantsWithAge(curam.core.facade.struct.ListMemberDetailsKey key)
                                                                                             throws curam.util.exception.AppException,
                                                                                                    curam.util.exception.InformationalException

Returns a list of case participants for a case with their age appended to their name.

Parameters:

key - The integrated case id.

Returns:

A list of case participants.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Case, CaseParticipant

listCaseParticipantsDetailsForContactLog

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListMemberDetails listCaseParticipantsDetailsForContactLog(curam.core.facade.struct.ListMemberDetailsKey listMemberDetailsKey)
                                                                                                          throws curam.util.exception.AppException,
                                                                                                                 curam.util.exception.InformationalException

Returns a list of case members for a case when the 'members only for contact log' property is set to true in administration. If this property is set to false then all case participants are returned without duplicates.

Parameters:

listMemberDetailsKey - The integrated case id.

Returns:

A list of case particpants.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

CaseParticipant

listContractDetails

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListCaseContractDetails listContractDetails(curam.core.facade.struct.ListContractKey listContractKey)
                                                                                           throws curam.util.exception.AppException,
                                                                                                  curam.util.exception.InformationalException

Returns the list of available contract details for a case.

Parameters:

key - The integrated case id.

Returns:

A list of contracts.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

CaseContract, ConcernRole, CaseParticipant

readNearestDeliveryPatternForCaseNominee

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.CaseNomineeDeliveryPatternDetails readNearestDeliveryPatternForCaseNominee(curam.core.facade.struct.CaseNomineeAndEffectiveDateKey key)
                                                                                                                          throws curam.util.exception.AppException,
                                                                                                                                 curam.util.exception.InformationalException

Reads the nearest active delivery pattern for a case nominee on an integrated case.

Parameters:

key - The case nominee ID and effective date.

Returns:

The delivery pattern details.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

CaseNominee

readOverviewMessageXML

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

Reads the messages XML details of a case.

Returns:: The message XML result details.
Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

Interface IntegratedCase

Method Summary

Method Detail

readOverview

addProductToIntegratedCase

addTaskToContract

cancelContract

cancelMemberNote

closeCase

createAssessment

createCaseHelper

createContract

createEvidenceMetadata

createICEvidenceLink

createMemberContract

createRecurringrActivity

createStandardUserActivity

deleteICEvidenceLink

listActiveCaseMembers

listActiveCaseMembersByCaseParticipantRoleID

listActiveProductDeliveryDecision

listActiveProductDeliveryDeduction

listAdminCaseRole

listAllCases

listAllCasesForParentCase

listAssessment

listAttachment

listCaseMembersExcProspectPerson

listCaseParticipantsDetails

listCaseParticipantsDetailsUsingCaseParticipantRoleID

listCaseRelationship

listClientRole

listContract

listCurrentActiveEvidenceMetadata

listICEvidenceLink

listInvestigation

listInvestigationDeliveryActionPlan

listInvestigationDeliveryAllegation

listInvestigationDeliveryAssessment

listInvestigationDeliveryAttachment

listInvestigationDeliveryCaseMember

listInvestigationDeliveryClientRole

listInvestigationDeliveryMilestone

listInvestigationDeliveryRelatedCase

listInvestigationDeliveryTask

listInvestigationDeliveryUserRole

listInvestigationUncompletedMilestone

listIssue

listMemberActivity

listMemberAndContractTemplate

listMemberAssessment

listMemberContract

listMemberContractDetails

listMemberDetails

listMemberFinancial

listMemberIssue

listMemberProduct

listMemberTasks

listProduct

listProductDeliveryAdminCaseRole

listProductDeliveryAppliedUnappliedDeduction

listProductDeliveryAttachment

listProductDeliveryCaseRelationship

listProductDeliveryClientRole

listProductDeliveryDecision

listProductDeliveryEvidence

listProductDeliveryFinancial

listProductDeliveryFinInstruction

listProductDeliveryInfoDetailsForCase

listProductDeliveryIssue

listProductDeliveryOverUnderPayment

listProductDeliveryRecentTransaction

listProductDeliveryTask

listProductDeliveryThirdPartyDeduction

listProductDeliveryUtilityPayment

listProductsForCategory

listRecentTransaction

listSpecialCaution

listSpecialCautionHistory

listTask