Person (core)

All Known Implementing Classes:

Person, curam.core.facade.impl.Person, PersonFactory
```
@AccessLevel(value=EXTERNAL)
public interface Person
```
This process class provides the functionality for the Person presentation layer.

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`cancelAddress(curam.core.facade.struct.CancelParticipantAddressKey key)` This method will change the record status of the Address record from Active to Canceled.
`void`	`cancelAlternateID(curam.core.facade.struct.CancelParticipantAlternateIDKey key)` This method will change the recordStatus of ConcernRoleAlternateID from Active to Cancel.
`void`	`cancelAlternativeName(curam.core.facade.struct.CancelPersonNameKey key)` Presentation layer operation to change the status of the alternate name from active to canceled
`void`	`cancelBankAccount(curam.core.facade.struct.CancelParticipantBankAccountKey key)` This method will change the record Status of BankAccount from Active to Canceled
`void`	`cancelCitizenship(curam.core.facade.struct.CancelCitizenshipKey key)` Cancels the specified citizenship details.
`void`	`cancelCommunicationException(curam.core.facade.struct.CancelParticipantCommunicationExceptionKey key)` This method will change the recordStatus of Communication Exception from Active to cancel.
`void`	`cancelContact(curam.core.facade.struct.CancelContactKey key)` This method modifies the status of the specified contact to 'Cancelled'.
`void`	`cancelEducation(curam.core.facade.struct.CancelEducationKey key)` Presentation layer operation to cancel an education record.
`void`	`cancelEmailAddress(curam.core.facade.struct.CancelParticipantEmailAddressKey key)` This method will change the recordStatus of EmailAddress from Active to cancel.
`void`	`cancelEmployment(curam.core.facade.struct.CancelEmploymentKey key)` Presentation layer operation to cancel the employment of the specified key.
`void`	`cancelEmploymentWorkingHour(curam.core.facade.struct.CancelEmploymentWorkingHourDetails key)` Presentation layer operation to cancel an employment working hour record.
`void`	`cancelForeignResidency(curam.core.facade.struct.CancelPersonForeignResidencyKey key)` Presentation Layer operation to cancel a foreign residency identified by the key passed.
`void`	`cancelNote(curam.core.facade.struct.CancelParticipantNoteDetails key)` This method will change the recordStatus of a participant note to 'cancelled'.
`curam.core.facade.struct.InformationMsgDtlsList`	`cancelParticipantBankAccount(curam.core.facade.struct.CancelParticipantBankAccountKey key)` This method will change the record Status of Bank Account from Active to Cancelled.
`void`	`cancelPhoneNumber(curam.core.facade.struct.CancelParticipantPhoneNumberKey key)` Cancels the specified phone number for the participant.
`void`	`cancelRelationship(curam.core.facade.struct.CancelPersonRelationshipDetailsKey key)` Presentation layer operation to cancel a relationship specified by the key.
`void`	`cancelUtilityPayment(curam.core.facade.struct.CancelUtilityPaymentKey key)` Cancels a utility payment for a person.
`void`	`cancelWebAddress(curam.core.facade.struct.CancelParticipantWebAddressDetails details)` This method will change the recordStatus of a concern role web address to 'cancelled'.
`curam.core.facade.struct.CreateParticipantAddressDetails`	`createAddress(curam.core.facade.struct.MaintainParticipantAddressDetails details)` This method creates a new address record for the specified concern role.
`void`	`createAdministrator(curam.core.facade.struct.ParticipantAdministratorDetails participantAdministratorDetails)` This method creates a new administrator for the concern role.
`curam.core.facade.struct.CreateParticipantAlternateIDDetails`	`createAlternateID(curam.core.facade.struct.MaintainParticipantAlternateIDDetails details)` Creates a new alternate ID for a concern role.
`curam.core.facade.struct.CreatedAlternateNameDetails`	`createAlternativeName(curam.core.facade.struct.MaintainPersonAlternativeNameDetails details)` Presentation layer to create a new name for the person.
`curam.core.facade.struct.CreateParticipantBankAccountDetails`	`createBankAccountWithTextSortCode(curam.core.facade.struct.MaintainParticipantBankAccountWithTextSortCodeDetails details)` Creates a new bank account for the specified concern role.
`curam.core.facade.struct.CreatedCitizenshipDetails`	`createCitizenship(curam.core.facade.struct.MaintainCitizenshipDetails details)` Creates a new citizenship for the specified person.
`void`	`createCommunicationException(curam.core.facade.struct.MaintainParticipantCommunicationExceptionDetails details)` Creates a communication exception record for the specified concern role.
`void`	`createContact(curam.core.facade.struct.CreateContactDetails details)` This method creates a concern role contact based on information supplied by the caseworker during processing.
`void`	`createContactFromUnregisteredParticipant(curam.core.facade.struct.CreateContactFromUnregisteredParticipant details)` Creates a contact record for a participant who was not previously registered.
`curam.core.facade.struct.CreatedEducationDetails`	`createEducation(curam.core.facade.struct.MaintainPersonEducationDetails details)` Presentation layer operation to create an education record
`curam.core.facade.struct.CreateParticipantEmailAddressDetails`	`createEmailAddress(curam.core.facade.struct.MaintainParticipantEmailAddressDetails details)` This method creates a new email address entry for the specified concern role.
`curam.core.facade.struct.InformationMsgDtlsList`	`createEmployment(curam.core.facade.struct.MaintainPersonEmploymentDetails details)` Presentation layer operation to create an employment record for the participant
`curam.core.facade.struct.CreatedEmploymentWorkingHourDetails`	`createEmploymentWorkingHour(curam.core.facade.struct.CreateEmploymentWorkingHourDetails dtls)` Presentation layer operation to create an employment working hour record.
`curam.core.facade.struct.CreatedForeignResidencyDetails`	`createForeignResidency(curam.core.facade.struct.MaintainPersonForeignResidencyDetails details)` Presentation Layer operation to create a foreign residency for a person.
`void`	`createHomePhoneNumber(curam.core.facade.struct.CreateHomePhoneNumber key)` This method creates a home phone number for a participant based on details supplied by the caseworker during case processing.
`void`	`createMailingAddress(curam.core.facade.struct.CreateMailingAddress key)` This method creates a mailing address for a participant based on address details supplied by the caseworker during case processing.
`void`	`createNote(curam.core.facade.struct.ParticipantNoteDetails details)` Creates a new note for the specified participant.
`curam.core.facade.struct.CreateParticipantPhoneDetails`	`createPhoneNumber(curam.core.facade.struct.MaintainParticipantPhoneDetails details)` Creates a new phone number for the specified participant.
`curam.core.facade.struct.CreatedRelationshipDetails`	`createRelationship(curam.core.facade.struct.MaintainPersonRelationships details)` Presentation layer operation to create a relationship for the specified participant.
`void`	`createWebAddress(curam.core.facade.struct.ParticipantWebAddressDetails details)` This method creates a web address for a participant based on details supplied by the caseworker during case processing.
`void`	`createWorkPhoneNumber(curam.core.facade.struct.CreateWorkPhoneNumber key)` This method creates a work phone number for a participant based on details supplied by the caseworker during case processing.
`curam.core.facade.struct.AddressString`	`displaySingleLineAddress(curam.core.struct.OtherAddressData otherAddressData)` Display the address given as a single line.
`void`	`endDeduction(curam.core.facade.struct.EndDeductionDetails details)` Adds an end date to any active third party deductions for a participant who has been ended.
`curam.core.facade.struct.BankAccountString`	`formatBankAcDetailsString(curam.core.struct.BankAccountRMDtls details)` Formats the bank account details for a participant.
`void`	`insertPrimaryResidenceAddress(curam.core.facade.struct.InsertPrimaryResAddress key)` This method creates a primary residence address for a participant based on details supplied by the caseworker during case processing.
`curam.core.facade.struct.ReadParticipantActiveAddressList`	`listActiveAddresses(curam.core.facade.struct.ReadParticipantAddressListKey key)` This method retrieves a list of active address details for the specified concern role.
`curam.core.facade.struct.ReadActiveBankAccountList`	`listActiveBankAccount(curam.core.facade.struct.ReadParticipantBankAccountListKey key)` Returns a list of active accounts for a participant.
`curam.core.facade.struct.BankAccountListForRedirectionDetails`	`listActiveBankAccountForRedirection1(curam.core.facade.struct.ParticipantBankAccountRedirectionKey1 key)` Method to list all active bank accounts for a Participant bank account redirection.
`curam.core.facade.struct.ListActiveBenefitCaseDetails`	`listActiveBenefitCase(curam.core.facade.struct.ListActiveBenefitCasesKey key)` Returns a list of active benefit cases for a person.
`curam.core.facade.struct.ReadParticipantAddressList`	`listAddress(curam.core.facade.struct.ReadParticipantAddressListKey key)` This method retrieves a list of address details for the specified concern role.
`curam.core.facade.struct.ReadAddressHistoryList`	`listAddressHistory(curam.core.facade.struct.ReadAddressHistoryListKey key)` Method returns a list of ConcernRole Address snapshot details.
`curam.core.facade.struct.ParticipantAddressStringList`	`listAddressString(curam.core.facade.struct.ReadParticipantAddressListKey key)` This method retrieves a list of address string details for the specified concern role.
`curam.core.facade.struct.ParticipantAdministratorDetailsList`	`listAdministrators(curam.core.facade.struct.ReadParticipantAdminRoleListKey readParticipantAdminRoleListKey)` This method retrieves all the administrators for the given concern role.
`curam.core.facade.struct.ParticipantAdministratorDetailsList`	`listAdministratorsForDuplicateParticipant(curam.core.facade.struct.ReadParticipantAdminRoleListKey readParticipantAdminRoleListKey)` This method retrieves a list of administrators for the specified duplicate concern role.
`curam.core.facade.struct.ListCasesByConcernRoleDetails`	`listAllCases(curam.core.facade.struct.SearchCasesByConcernRoleKey key)` Returns all cases for a participant.
`curam.core.facade.struct.ReadParticipantAlternateIDList`	`listAlternateID(curam.core.facade.struct.ReadParticipantAlternateIDListKey key)` Retrieves a list of alternate ID's for this concern role.
`curam.core.facade.struct.ReadParticipantAltIDHistoryList`	`listAlternateIDHistory(curam.core.facade.struct.ReadParticipantAltIDHistoryListKey key)` Method returns a list of ConcernRole AlternateID Snapshot details.
`curam.core.facade.struct.PersonNameRMDtlsList`	`listAlternativeName(curam.core.facade.struct.ReadPersonAlternativeNameListKey key)` Presentation layer operation to retrieve a list of name details for the specified person
`curam.core.facade.struct.ReadPersonNameHistoryList`	`listAlternativeNameHistory(curam.core.facade.struct.ReadPersonNameHistoryListKey key)` Method returns a list of Alternative Name Snapshot details.
`curam.core.facade.struct.ParticipantAssessmentsList`	`listAssessments(curam.core.struct.ConcernRoleKey concernRoleKey)` Returns a list of assessments for the participant.
`curam.core.facade.struct.ReadParticipantBankAccountList`	`listBankAccount(curam.core.facade.struct.ReadParticipantBankAccountListKey key)` Retrieves a list of bank accounts for the specified concern role.
`curam.core.facade.struct.ReadParticipantBankAcHistoryList`	`listBankAccountHistory(curam.core.facade.struct.ReadParticipantBankAcHistoryListKey key)` Method returns a list of ConcernRole Bank Account Snapshot details.
`curam.core.facade.struct.ParticipantBankAccountStringList`	`listBankAccountString(curam.core.facade.struct.MaintainConcernRoleKey key)` Lists the details for a bank account in a single string format for the user.
`curam.core.facade.struct.ReadCitizenshipList`	`listCitizenship(curam.core.facade.struct.ReadCitizenshipListKey key)` Retrieves a list of citizenship summary details for the specified person.
`curam.core.facade.struct.ReadCitizenshipHistoryList`	`listCitizenshipHistory(curam.core.facade.struct.ReadCitizenshipHistoryListKey key)` Method returns a list of Citizenship Snapshot summary details.
`curam.core.facade.struct.CommunicationDetailList`	`listCommunication(curam.core.facade.struct.ParticipantCommunicationKey key)` To list all communications for a participant.
`curam.core.facade.struct.ReadParticipantCommunicationExceptionList`	`listCommunicationException(curam.core.facade.struct.ReadParticipantCommunicationExceptionListKey key)` Retrieves a list of communication exceptions for the specified concern role.
`curam.core.facade.struct.ListConcernContactDetails`	`listConcernContact(curam.core.facade.struct.ListContactKey key)` This method list all contacts for a participant.
`curam.core.facade.struct.ReadParticipantConcernRoleList`	`listConcernRole(curam.core.facade.struct.ReadParticipantConcernRoleKey key)` reads a list of the concerns roles within the organization
`curam.core.facade.struct.ReadDuplicateParticipantConcernRoleList`	`listConcernRoleForDuplicate(curam.core.facade.struct.ReadParticipantConcernRoleKey key)` Retrieves role details for a specified duplicate concern.
`curam.core.facade.struct.ListContactDetails`	`listContact(curam.core.facade.struct.ListContactKey key)` Deprecated. Since Curam 6.0 SP3, replaced by `#listConcernContact()`. The return struct of the current method listContact has an aggregation to the struct ConcernContactRMDtls, the attribute statusCode in the struct ConcernContactRMDtls is modeled with a domain of CONTACTSTATUS code-table, but the corresponding entity attribute ConcernRoleContactDtls.statusCode is modeled with a domain of RECORD_STATUS_CODE. So new method is introduced to return new struct ListConcernContactDetails which has an aggregation to the new struct ConcernContactRMultiDtls where the attribute statusCode is modeled with a domain of RECORD_STATUS_CODE. See release note: CEF-8999.
`curam.core.facade.struct.ReadParticipantDeductionList`	`listDeduction(curam.core.facade.struct.ConcernRoleKeyStruct key)` Returns a list of deductions for a participant.
`curam.core.facade.struct.ReadParticipantDeductionList1`	`listDeduction1(curam.core.facade.struct.ConcernRoleKeyStruct key)` Returns a list of deductions for a participant.
`curam.core.facade.struct.ReadDuplicateParticipantDeductionList`	`listDeductionForDuplicate(curam.core.facade.struct.ConcernRoleKeyStruct key)` Returns a list of deductions for a duplicate participant.
`curam.core.facade.struct.ReadEducationDetailsList`	`listEducation(curam.core.facade.struct.ReadEducationListByConcernKey key)` Presentation layer operation to show a list of all education records for the participant
`curam.core.facade.struct.ReadEducationHistoryList`	`listEducationHistory(curam.core.facade.struct.ReadEducationHistoryListKey key)` Method returns a list of Education Snapshot summary details.
`curam.core.facade.struct.ReadParticipantEmailAddressList`	`listEmailAddress(curam.core.facade.struct.ReadParticipantEmailAddressListKey key)` Retrieves a list of email address details for the specified concern role.
`curam.core.facade.struct.ReadEmploymentDetailsWithMsgList`	`listEmployment1(curam.core.facade.struct.ReadPersonEmploymentListKey key)` COMMENTS="This method replaces the deprecated method `listEmployment(ReadPersonEmploymentListKey)`.
`curam.core.facade.struct.ReadEmploymentHistoryList`	`listEmploymentHistory(curam.core.facade.struct.ReadEmploymentHistoryListKey key)` Method returns a list of Employment Snapshot details.
`curam.core.facade.struct.EmploymentWorkingHourList`	`listEmploymentWorkingHour(curam.core.facade.struct.ListEmploymentWorkingHourKey key)` Presentation layer operation to list employment working hour records.
`curam.core.facade.struct.EmploymentWorkingHourAndVersionNoList`	`listEmploymentWorkingHourAndVersionNo(curam.core.facade.struct.ListEmploymentWorkingHourKey key)` Presentation layer operation to list employment working hour records.
`curam.core.facade.struct.ReadEmploymentWorkingHourHistoryList`	`listEmploymentWorkingHourHistory(curam.core.facade.struct.ReadEmploymentWorkingHourHistoryListKey key)` Method returns a list of Employment Working Hour Snapshot details.
`curam.core.facade.struct.ReadPersonForeignResidencyDetailsList`	`listForeignResidency(curam.core.facade.struct.ReadPersonForeignResidencyListKey key)` Presentation Layer operation to list all the foreign residencies for a participant.
`curam.core.facade.struct.ReadPersonForeignResidencyHistoryList`	`listForeignResidencyHistory(curam.core.facade.struct.ReadPersonForeignResidencyHistoryListKey key)` Method returns a list of Foreign Residency Snapshot details.
`curam.core.facade.struct.FormattedAddressList`	`listFormattedAddress(curam.core.facade.struct.ReadParticipantFormattedAddressListKey readParticipantFormattedAddressListKey)` Method to return a list of formatted address for a participant.
`curam.core.facade.struct.FormattedBankAccountList`	`listFormattedBankAccount(curam.core.facade.struct.ReadParticipantFormattedBankAccountListKey readParticipantFormattedBankAccountListKey)` Method to return a list of formatted Bank Accounts.
`curam.core.facade.struct.ListInteractionDetails`	`listInteraction(curam.core.facade.struct.ListInteractionKey key)` This method returns a list of client interactions details.
`curam.core.facade.struct.ListDuplicateParticipantInteractionDetails`	`listInteractionForDuplicate(curam.core.facade.struct.ListInteractionKey key)` Retrieves interaction details for a specified duplicate concern.
`curam.core.facade.struct.ParticipantInvestigationList`	`listInvestigations(curam.core.facade.struct.SearchCaseKey_fo concernRoleKey)` Lists the investigations related to a participant.
`curam.core.facade.struct.ListParticipantIssuedPaymentInstrument`	`listIssuedPaymentInstrument(curam.core.facade.struct.ConcernRoleKeyStruct key)` Returns a list of issued payment instruments for a concern, and also for when the concern is the nominee.
`curam.core.facade.struct.ListDuplicateParticipantIssuedPaymentInstrument`	`listIssuedPaymentInstrumentForDuplicate(curam.core.facade.struct.ConcernRoleKeyStruct key)` Returns a list of issued payment instruments for a duplicate concern..
`curam.core.facade.struct.ParticipantNoteList1`	`listNote1(curam.core.facade.struct.ParticipantKey key)` Retrieves a list of notes details for the specified participant.
`curam.core.facade.struct.ListParticipantFinancials1`	`listParticipantFinancial1(curam.core.facade.struct.ListParticipantFinancialsKey key)` COMMENTS=Returns a list of financials for a participant.
`curam.core.facade.struct.ListDuplicateParticipantFinancials`	`listParticipantFinancialForDuplicate(curam.core.facade.struct.ListParticipantFinancialsKey key)` Returns a list of financials for a duplicate participant.
`curam.core.facade.struct.TasksForConcernAndCaseDetails`	`listParticipantTask(curam.core.facade.struct.ListParticipantTaskKey_eo key)` Returns a list of tasks for a participant.
`curam.core.facade.struct.TasksForDuplicateConcernAndCaseDetails`	`listParticipantTaskForDuplicate(curam.core.facade.struct.ListParticipantTaskKey_eo key)` Returns a list of tasks for a duplicate participant.
`curam.core.facade.struct.ReadPersonHistoryList`	`listPersonHistory(curam.core.facade.struct.ReadPersonHistoryListKey key)` Method returns a list of Person snapshot details.
`curam.core.facade.struct.ReadParticipantPhoneNumberList`	`listPhoneNumber(curam.core.facade.struct.ReadParticipantPhoneNumberListKey key)` Returns a list of phone numbers for the participant, along with a context description.
`curam.core.facade.struct.RaceCodeList`	`listRace()` Returns the list of races to be displayed as a multi select dropdown
`curam.core.facade.struct.ReadPersonRelationshipList`	`listRelationship(curam.core.facade.struct.ReadPersonRelationshipListKey key)` Presentation layer operation to get a list of relationships for a participant identified by the key.
`curam.core.facade.struct.ReadRelationshipHistoryList`	`listRelationshipHistory(curam.core.facade.struct.ReadRelationshipHistoryListKey key)` Method returns a list of Relationship snapshot details.
`curam.core.facade.struct.ParticipantScreeningList`	`listScreeningCases(curam.core.facade.struct.SearchCaseKey_fo key)` Lists all screening cases for a participant.
`curam.core.facade.struct.ListTemplateByTypeAndParticpant`	`listTemplateByTypeAndParticipant(curam.core.facade.struct.ListTemplateByTypeAndParticipantKey key)` Returns a list of templates for a particular type and participant.
`curam.core.facade.struct.ReadUtilityPaymentsList`	`listUtilityPayment(curam.core.facade.struct.ReadUtilityPaymentsListKey key)` Presentation layer operation to list utility payments for the passed concern role id.
`curam.core.facade.struct.ConcernRoleWaitListStructList`	`listWaitList(curam.core.struct.ConcernRoleKey key)` This method is intended to be used by the case worker user role for listing the open wait list entries for a Person.
`curam.core.facade.struct.ParticipantWebAddressList`	`listWebAddress(curam.core.facade.struct.ParticipantWebAddressListKey key)` Retrieves a list of web address details for the specified concern role.
`curam.core.facade.struct.ModifiedAddressDetails`	`modifyAddress(curam.core.facade.struct.MaintainParticipantAddressDetails details)` This method modifies existing address information for the concern role.
`curam.core.facade.struct.ModifiedAlternateIDDetails`	`modifyAlternateID(curam.core.facade.struct.MaintainParticipantAlternateIDDetails details)` Modifies an existing concern role alternate ID returning any details that may exist.
`curam.core.facade.struct.ModifiedAlternateNameDetails`	`modifyAlternativeName(curam.core.facade.struct.MaintainPersonAlternativeNameDetails details)` Presentation layer operation to modify an existing name for the specified person
`curam.core.facade.struct.InformationMsgDtlsList`	`modifyBankAccountWithTextSortCode(curam.core.facade.struct.MaintainParticipantBankAccountWithTextSortCodeDetails details)` Modifies an existing bank account for the specified concern role.
`curam.core.facade.struct.ModifiedCitizenshipDetails`	`modifyCitizenship(curam.core.facade.struct.MaintainCitizenshipDetails details)` Modifies the specified citizenship details for the person.
`curam.core.facade.struct.InformationalMsgDetailsList`	`modifyClientEvidence(curam.core.struct.ModifyClientEvidenceDetails details)` Presentation layer operation to update a clients evidence details returning informational message details.
`void`	`modifyCommunicationException(curam.core.facade.struct.MaintainParticipantCommunicationExceptionDetails details)` Modifies an existing communication exception for the specified concern role.
`void`	`modifyConcernContact(curam.core.facade.struct.ModifyConcernContactDetails details)` This method modifies a contact for a participant.
`void`	`modifyContact(curam.core.facade.struct.ModifyContactDetails details)` Deprecated. Since Curam 6.0 SP3, replaced by `#modifyConcernContact()`. The parameter struct of the current method modifyContact has an aggregation to the struct ConcernContactDtls, the attribute statusCode in the struct ConcernContactDtls is modeled with a domain of CONTACTSTATUS code-table, but the corresponding entity attribute ConcernRoleContactDtls.statusCode is modeled with a domain of RECORD_STATUS_CODE. So new method is introduced to have new parameter ModifyConcernContactDetails which has an aggregation to the new struct ConcernContactRMultiDtls where the attribute statusCode is modeled with a domain of RECORD_STATUS_CODE. See release note: CEF-8999.
`curam.core.facade.struct.ModifiedEducationDetails`	`modifyEducation(curam.core.facade.struct.MaintainPersonEducationDetails details)` Presentation layer operation to update an education record
`void`	`modifyEmailAddress(curam.core.facade.struct.MaintainParticipantEmailAddressDetails details)` This method modifies an existing email address of the specified concern role.
`curam.core.facade.struct.ModifedEmploymentDetails`	`modifyEmployment(curam.core.facade.struct.MaintainPersonEmploymentDetails details)` Presentation layer operation to modify employment details
`curam.core.facade.struct.ModifiedEmploymentWorkingHourDetails`	`modifyEmploymentWorkingHour(curam.core.facade.struct.ModifyEmploymentWorkingHourDetails dtls)` Presentation layer operation to modify an employment working hour record.
`curam.core.facade.struct.ModifiedForeignResidencyDetails`	`modifyForeignResidency(curam.core.facade.struct.MaintainPersonForeignResidencyDetails details)` Presentation Layer operation to modify a foreign residency.
`void`	`modifyNote1(curam.core.facade.struct.ModifyParticipantNoteDetails1 details)` Modifies an existing note for the specified concern role.
`curam.core.facade.struct.InformationalMsgDetailsList`	`modifyPerson(curam.core.facade.struct.MaintainPersonDetails details)` Presentation layer operation to update a persons details returning informational message details.
`curam.core.facade.struct.InformationalMsgDetailsList`	`modifyPersonEvidence(curam.core.struct.ModifyPersonEvidenceDetails details)` Presentation layer operation to update a persons evidence details returning informational message details.
`void`	`modifyPhoneNumber(curam.core.facade.struct.MaintainParticipantPhoneDetails details)` Modifies an existing phone number for the participant.
`curam.core.facade.struct.ModifiedRelationshipDetails`	`modifyRelationship(curam.core.facade.struct.MaintainPersonRelationships details)` Presentation layer operation to modify the specified relationship.
`void`	`modifySentCommunication(curam.core.facade.struct.ModifySentCommunicationDetails details)` Modifies the details of a sent communication.
`void`	`modifyUtilityPayment(curam.core.facade.struct.MaintainUtilityPaymentsDetails details)` Presentation layer operation to modify a utility payment with the details passed in.
`void`	`modifyWebAddress(curam.core.facade.struct.ParticipantWebAddressDetails details)` This method modifies an existing web address of the specified concern role.
`void`	`printCommunication(curam.core.facade.struct.PrintCommunicationKey key)` Prints a communication.
`curam.core.facade.struct.ReadParticipantAddressDetails`	`readAddress(curam.core.facade.struct.ReadParticipantAddressKey key)` This method retrieves address details for a specified concern role address.
`curam.core.facade.struct.ReadParticipantAlternateIDDetails`	`readAlternateID(curam.core.facade.struct.ReadParticipantAlternateIDKey key)` Retrieves the details of the specified alternate ID.
`curam.core.facade.struct.ReadPersonNameDetails`	`readAlternativeName(curam.core.facade.struct.ReadPersonNameKey key)` Presentation layer operation to retrieve the name of the details specified
`curam.core.facade.struct.ReadParticipantBankAccountDetails`	`readBankAccount(curam.core.facade.struct.ReadParticipantBankAccountKey key)` Retrieves bank account details for the concern role.
`curam.core.facade.struct.PersonReadDtls`	`readByReferenceNumber(curam.core.facade.struct.PersonAlternateIDSearchKey key)` Deprecated. Since Curam 6.0.5.3
`curam.core.facade.struct.ReadCitizenshipDetails`	`readCitizenship(curam.core.facade.struct.ReadCitizenshipKey key)` Retrieves the details of the specified citizenship, along with a context description.
`curam.core.struct.ReadClientEvidenceDetails`	`readClientEvidence(curam.core.facade.struct.ReadPersonKey key)` Reads the client's evidence details.
`curam.core.facade.struct.ReadCommunicationAttachmentDetails`	`readCommunicationAttachment(curam.core.facade.struct.ReadAttachmentKey key)` Method to return communication attachment details.
`curam.core.facade.struct.ReadParticipantCommunicationExceptionDetails`	`readCommunicationException(curam.core.facade.struct.ReadParticipantCommunicationExceptionKey key)` Retrieves the details of a specified communication exception.
`curam.core.facade.struct.ReadConcernContactDetails`	`readConcernContact(curam.core.facade.struct.ReadContactKey key)` This method returns details of a contact for a participant.
`curam.core.facade.struct.ConcernRoleTypeDetails`	`readConcernRoleType(curam.core.facade.struct.ReadParticipantConcernRoleKey key)` Reads the concern role type for a participant.
`curam.core.facade.struct.ReadContactDetails`	`readContact(curam.core.facade.struct.ReadContactKey key)` Deprecated. Since Curam 6.0 SP3, replaced by `#readConcernContact()`. The return struct of the current method readContact has an aggregation to the struct ConcernContactDtls, the attribute statusCode in the struct ConcernContactDtls is modeled with a domain of CONTACTSTATUS code-table, but the corresponding entity attribute ConcernRoleContactDtls.statusCode is modeled with a domain of RECORD_STATUS_CODE. So new method is introduced to return new struct ReadConcernContactDetails which has an aggregation to the new struct ConcernContactRMultiDtls where the attribute statusCode is modeled with a domain of RECORD_STATUS_CODE. See release note: CEF-8999.
`curam.core.facade.struct.ParticipantContextDetails`	`readContextDescription(curam.core.facade.struct.ParticipantContextKey key)` Retrieves a context description for the specified participant.
`curam.core.facade.struct.ReadEducationDetails`	`readEducation(curam.core.facade.struct.EducationReadKey key)` Presentation layer operation to read an education record based on the education record key
`curam.core.facade.struct.ReadParticipantEmailAddressDetails`	`readEmailAddress(curam.core.facade.struct.ReadParticipantEmailAddressKey key)` Retrieves the details of the specified email address.
`curam.core.facade.struct.ReadEmploymentDetails`	`readEmployment(curam.core.facade.struct.ReadEmploymentKey key)` This method retrieves details for an existing employment for a participant.
`curam.core.facade.struct.ReadEmploymentWorkingHourDetails`	`readEmploymentWorkingHour(curam.core.facade.struct.EmploymentWorkingHourKey key)` Presentation layer operation to read an employment working hour record.
`curam.core.facade.struct.EmploymentWorkingHourContextDescription`	`readEmploymentWorkingHourContextDescription(curam.core.facade.struct.EmploymentWorkingHourContextDescriptionKey key)` Returns the employment working hour context description.
`curam.core.facade.struct.ReadPersonForeignResidencyDetails`	`readForeignResidency(curam.core.facade.struct.ReadPersonForeignResidencyKey key)` Presentation Layer operation to read the details of a foreign residency specified by the foreign residency key.
`curam.core.facade.struct.PersonNameAndAddressDetails`	`readFullNameAndAddress(curam.core.facade.struct.ReadPersonKey key)` Reads the person's full name and address.
`curam.core.facade.struct.PersonSearchFurtherDtls`	`readFurtherDetails(curam.core.facade.struct.PersonSearchMaintainConcernRoleKey key)` Presentation layer operation called to return further details about a person selected from the person search
`curam.core.facade.struct.ReadPersonHomeDetails`	`readHomePageDetails(curam.core.facade.struct.ReadPersonHomeKey key)` Presentation layer operation to retrieve home page information for a person.
`curam.core.facade.struct.ReadPersonHomeDetailsShowTasks`	`readHomePageDetailsShowTasks(curam.core.facade.struct.ReadPersonHomeKey key)` Presentation layer operation to retrieve home page information for a person.
`curam.core.facade.struct.InformationalMsgDetailsList`	`readInformationalMessage(curam.core.facade.struct.MaintainConcernRoleKey key)` This method is used to read the information message.
`curam.core.facade.struct.ReadInteractionDetails`	`readInteraction(curam.core.facade.struct.ReadInteractionKey key)` This method retrieves a person's interaction details.
`curam.core.facade.struct.ReadParticipantNoteDetails1`	`readNote1(curam.core.facade.struct.ParticipantNoteKey key)` Retrieves the details of the specified participant note.
`curam.core.facade.struct.ContactContextDescriptionDetails`	`readParticipantContactContextDescription(curam.core.facade.struct.ContactContextDescriptionKey key)` Reads the description of the Contact.
`curam.core.facade.struct.ReadPersonDetails`	`readPerson(curam.core.facade.struct.ReadPersonKey key)` Reads the details of the specified person.
`curam.core.facade.struct.PersonDetails`	`readPersonDetails(curam.core.facade.struct.ConcernRoleIDKey key)` Reads the details of the specified person.
`curam.core.struct.ReadPersonEvidenceDetails`	`readPersonEvidence(curam.core.facade.struct.ReadPersonKey key)` Reads the person's evidence details.
`curam.core.struct.ReadPersonEvidenceDetails`	`readPersonEvidenceForModify(curam.core.facade.struct.ReadPersonKey key)` Reads the person's evidence details.
`curam.core.facade.struct.ReadParticipantPhoneNumberDetails`	`readPhoneNumber(curam.core.facade.struct.ReadParticipantPhoneNumberKey key)` Retrieves details of the specified phone number for the participant, along with a context description.
`curam.core.facade.struct.ReadPersonRelationshipDetails`	`readRelationship(curam.core.facade.struct.ReadPersonRelationshipDetailsKey key)` Presentation layer operation to display relationship details for the specified key.
`curam.core.facade.struct.ReadUtilityPaymentDetails`	`readUtilityPayment(curam.core.facade.struct.ReadUtilityPaymentKey key)` Presentation layer operation to read specific details of a utility payment specified by the key passed in.
`curam.core.facade.struct.ReadParticipantWebAddressDetails`	`readWebAddress(curam.core.facade.struct.ParticipantWebAddressKey key)` Retrieves the details of the specified web address.
`curam.core.facade.struct.PersonRegistrationResult`	`register(curam.core.facade.struct.PersonRegistrationDetails details)` Called to register a new person.
`void`	`removeAddress(curam.core.facade.struct.ReadParticipantAddressKey key)` This method removes the specified address details for the concern role.
`curam.core.facade.struct.ParticipantHomePageName`	`resolveProspectHome(curam.core.facade.struct.ConcernRoleKeyStruct key)` Resolves the participant home page based on the key
`curam.core.struct.PersonReadDtlsList`	`searchByReferenceNumber(curam.core.facade.struct.PersonAlternateIDSearchKey key)` Searched people by the specified primary alternate id.
`curam.core.facade.struct.SearchCaseDetails1`	`searchCase1(curam.core.facade.struct.SearchCaseKey_fo key)` Searches for cases for the specified person.
`curam.core.facade.struct.SearchCasesForDuplicateDetails1`	`searchCaseForDuplicate1(curam.core.facade.struct.SearchCaseKey_fo key)` Searches for cases for the specified duplicate person and also returns a link to the case list for the original person.
`curam.core.facade.struct.IndigenousGroupList`	`searchIndigenousGroup(curam.core.facade.struct.IndigenousGroupSearchKey key)` Returns the list of indigenous group based on the key.
`curam.core.facade.struct.AllParticipantSearchDetails`	`searchParticipantDetails(curam.core.facade.struct.AllParticipantSearchKey key)` Searches for all participants by specified search criteria.
`curam.core.facade.struct.PersonSearchDetailsResult`	`searchPerson(curam.core.facade.struct.PersonSearchKey1 key)` Search person details by provided search criteria.
`curam.core.facade.struct.PersonSearchDetailsResult`	`searchPersonForPopup(curam.core.facade.struct.PersonSearchKey1 key)` Search persons details by provided search criteria.
`curam.core.facade.struct.PersonSearchDetailsResult`	`searchPersonWithoutProspectForPopup(curam.core.facade.struct.PersonSearchKey1 key)` Search persons details by provided search criteria.
`void`	`updateBankAccountPaymentDetails(curam.core.facade.struct.UpdateBankAccPaymentDtlsKey key)` Allows the user to select a new bank account that all future benefit payments will be paid to.

Method Detail

createCitizenship

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.CreatedCitizenshipDetails createCitizenship(curam.core.facade.struct.MaintainCitizenshipDetails details)
                                                                                           throws curam.util.exception.AppException,
                                                                                                  curam.util.exception.InformationalException

Creates a new citizenship for the specified person.

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

modifyCitizenship

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ModifiedCitizenshipDetails modifyCitizenship(curam.core.facade.struct.MaintainCitizenshipDetails details)
                                                                                            throws curam.util.exception.AppException,
                                                                                                   curam.util.exception.InformationalException

Modifies the specified citizenship details for the person.

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

readCitizenship

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadCitizenshipDetails readCitizenship(curam.core.facade.struct.ReadCitizenshipKey key)
                                                                                      throws curam.util.exception.AppException,
                                                                                             curam.util.exception.InformationalException

Retrieves the details of the specified citizenship, along with a context description.

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

cancelCitizenship

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

Cancels the specified citizenship details.

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

listCitizenship

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadCitizenshipList listCitizenship(curam.core.facade.struct.ReadCitizenshipListKey key)
                                                                                   throws curam.util.exception.AppException,
                                                                                          curam.util.exception.InformationalException

Retrieves a list of citizenship summary details for the specified person.

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

readByReferenceNumber

@Deprecated
 @AccessLevel(value=EXTERNAL)
curam.core.facade.struct.PersonReadDtls readByReferenceNumber(curam.core.facade.struct.PersonAlternateIDSearchKey key)
                                                                                                 throws curam.util.exception.AppException,
                                                                                                        curam.util.exception.InformationalException

Deprecated. Since Curam 6.0.5.3

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

readFurtherDetails

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.PersonSearchFurtherDtls readFurtherDetails(curam.core.facade.struct.PersonSearchMaintainConcernRoleKey key)
                                                                                          throws curam.util.exception.AppException,
                                                                                                 curam.util.exception.InformationalException

Presentation layer operation called to return further details about a person selected from the person search

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

createAlternativeName

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.CreatedAlternateNameDetails createAlternativeName(curam.core.facade.struct.MaintainPersonAlternativeNameDetails details)
                                                                                                 throws curam.util.exception.AppException,
                                                                                                        curam.util.exception.InformationalException

Presentation layer to create a new name for the person.

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

modifyAlternativeName

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ModifiedAlternateNameDetails modifyAlternativeName(curam.core.facade.struct.MaintainPersonAlternativeNameDetails details)
                                                                                                  throws curam.util.exception.AppException,
                                                                                                         curam.util.exception.InformationalException

Presentation layer operation to modify an existing name for the specified person

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

listAlternativeName

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.PersonNameRMDtlsList listAlternativeName(curam.core.facade.struct.ReadPersonAlternativeNameListKey key)
                                                                                        throws curam.util.exception.AppException,
                                                                                               curam.util.exception.InformationalException

Presentation layer operation to retrieve a list of name details for the specified person

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

readAlternativeName

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadPersonNameDetails readAlternativeName(curam.core.facade.struct.ReadPersonNameKey key)
                                                                                         throws curam.util.exception.AppException,
                                                                                                curam.util.exception.InformationalException

Presentation layer operation to retrieve the name of the details specified

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

cancelAlternativeName

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

Presentation layer operation to change the status of the alternate name from active to canceled

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

createEducation

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.CreatedEducationDetails createEducation(curam.core.facade.struct.MaintainPersonEducationDetails details)
                                                                                       throws curam.util.exception.AppException,
                                                                                              curam.util.exception.InformationalException

Presentation layer operation to create an education record

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

modifyEducation

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ModifiedEducationDetails modifyEducation(curam.core.facade.struct.MaintainPersonEducationDetails details)
                                                                                        throws curam.util.exception.AppException,
                                                                                               curam.util.exception.InformationalException

Presentation layer operation to update an education record

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

readEducation

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadEducationDetails readEducation(curam.core.facade.struct.EducationReadKey key)
                                                                                  throws curam.util.exception.AppException,
                                                                                         curam.util.exception.InformationalException

Presentation layer operation to read an education record based on the education record key

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

listEducation

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadEducationDetailsList listEducation(curam.core.facade.struct.ReadEducationListByConcernKey key)
                                                                                      throws curam.util.exception.AppException,
                                                                                             curam.util.exception.InformationalException

Presentation layer operation to show a list of all education records for the participant

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

cancelEducation

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

Presentation layer operation to cancel an education record.

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

createEmployment

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

Presentation layer operation to create an employment record for the participant

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

modifyEmployment

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ModifedEmploymentDetails modifyEmployment(curam.core.facade.struct.MaintainPersonEmploymentDetails details)
                                                                                         throws curam.util.exception.AppException,
                                                                                                curam.util.exception.InformationalException

Presentation layer operation to modify employment details

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

readEmployment

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadEmploymentDetails readEmployment(curam.core.facade.struct.ReadEmploymentKey key)
                                                                                    throws curam.util.exception.AppException,
                                                                                           curam.util.exception.InformationalException

This method retrieves details for an existing employment for a participant. Called during case processing by a caseworker.

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

cancelEmployment

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

Presentation layer operation to cancel the employment of the specified key.

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

createForeignResidency

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.CreatedForeignResidencyDetails createForeignResidency(curam.core.facade.struct.MaintainPersonForeignResidencyDetails details)
                                                                                                     throws curam.util.exception.AppException,
                                                                                                            curam.util.exception.InformationalException

Presentation Layer operation to create a foreign residency for a person.

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

modifyForeignResidency

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ModifiedForeignResidencyDetails modifyForeignResidency(curam.core.facade.struct.MaintainPersonForeignResidencyDetails details)
                                                                                                      throws curam.util.exception.AppException,
                                                                                                             curam.util.exception.InformationalException

Presentation Layer operation to modify a foreign residency.

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

readForeignResidency

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadPersonForeignResidencyDetails readForeignResidency(curam.core.facade.struct.ReadPersonForeignResidencyKey key)
                                                                                                      throws curam.util.exception.AppException,
                                                                                                             curam.util.exception.InformationalException

Presentation Layer operation to read the details of a foreign residency specified by the foreign residency key.

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

listForeignResidency

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadPersonForeignResidencyDetailsList listForeignResidency(curam.core.facade.struct.ReadPersonForeignResidencyListKey key)
                                                                                                          throws curam.util.exception.AppException,
                                                                                                                 curam.util.exception.InformationalException

Presentation Layer operation to list all the foreign residencies for a participant.

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

cancelForeignResidency

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

Presentation Layer operation to cancel a foreign residency identified by the key passed.

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

modifyPerson

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.InformationalMsgDetailsList modifyPerson(curam.core.facade.struct.MaintainPersonDetails details)
                                                                                        throws curam.util.exception.AppException,
                                                                                               curam.util.exception.InformationalException

Presentation layer operation to update a persons details returning informational message details.

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

createRelationship

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.CreatedRelationshipDetails createRelationship(curam.core.facade.struct.MaintainPersonRelationships details)
                                                                                             throws curam.util.exception.AppException,
                                                                                                    curam.util.exception.InformationalException

Presentation layer operation to create a relationship for the specified participant.

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

modifyRelationship

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ModifiedRelationshipDetails modifyRelationship(curam.core.facade.struct.MaintainPersonRelationships details)
                                                                                              throws curam.util.exception.AppException,
                                                                                                     curam.util.exception.InformationalException

Presentation layer operation to modify the specified relationship.

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

readRelationship

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadPersonRelationshipDetails readRelationship(curam.core.facade.struct.ReadPersonRelationshipDetailsKey key)
                                                                                              throws curam.util.exception.AppException,
                                                                                                     curam.util.exception.InformationalException

Presentation layer operation to display relationship details for the specified key.

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

listRelationship

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

Presentation layer operation to get a list of relationships for a participant identified by the key.

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

cancelRelationship

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

Presentation layer operation to cancel a relationship specified by the key.

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

modifyUtilityPayment

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

Presentation layer operation to modify a utility payment with the details passed in.

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

readUtilityPayment

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadUtilityPaymentDetails readUtilityPayment(curam.core.facade.struct.ReadUtilityPaymentKey key)
                                                                                            throws curam.util.exception.AppException,
                                                                                                   curam.util.exception.InformationalException

Presentation layer operation to read specific details of a utility payment specified by the key passed in.

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

listUtilityPayment

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

Presentation layer operation to list utility payments for the passed concern role id.

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

readHomePageDetails

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadPersonHomeDetails readHomePageDetails(curam.core.facade.struct.ReadPersonHomeKey key)
                                                                                         throws curam.util.exception.AppException,
                                                                                                curam.util.exception.InformationalException

Presentation layer operation to retrieve home page information for a person.

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

register

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.PersonRegistrationResult register(curam.core.facade.struct.PersonRegistrationDetails details)
                                                                                 throws curam.util.exception.AppException,
                                                                                        curam.util.exception.InformationalException

Called to register a new person.

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

readPerson

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadPersonDetails readPerson(curam.core.facade.struct.ReadPersonKey key)
                                                                            throws curam.util.exception.AppException,
                                                                                   curam.util.exception.InformationalException

Reads the details of the specified person.

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

listAllCases

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

Returns all cases for a participant.

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

readFullNameAndAddress

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.PersonNameAndAddressDetails readFullNameAndAddress(curam.core.facade.struct.ReadPersonKey key)
                                                                                                  throws curam.util.exception.AppException,
                                                                                                         curam.util.exception.InformationalException

Reads the person's full name and address.

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

listActiveBenefitCase

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListActiveBenefitCaseDetails listActiveBenefitCase(curam.core.facade.struct.ListActiveBenefitCasesKey key)
                                                                                                  throws curam.util.exception.AppException,
                                                                                                         curam.util.exception.InformationalException

Returns a list of active benefit cases for a person.

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

cancelEmploymentWorkingHour

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

Presentation layer operation to cancel an employment working hour record.

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

createEmploymentWorkingHour

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.CreatedEmploymentWorkingHourDetails createEmploymentWorkingHour(curam.core.facade.struct.CreateEmploymentWorkingHourDetails dtls)
                                                                                                               throws curam.util.exception.AppException,
                                                                                                                      curam.util.exception.InformationalException

Presentation layer operation to create an employment working hour record.

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

modifyEmploymentWorkingHour

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ModifiedEmploymentWorkingHourDetails modifyEmploymentWorkingHour(curam.core.facade.struct.ModifyEmploymentWorkingHourDetails dtls)
                                                                                                                throws curam.util.exception.AppException,
                                                                                                                       curam.util.exception.InformationalException

Presentation layer operation to modify an employment working hour record.

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

listEmploymentWorkingHour

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.EmploymentWorkingHourList listEmploymentWorkingHour(curam.core.facade.struct.ListEmploymentWorkingHourKey key)
                                                                                                   throws curam.util.exception.AppException,
                                                                                                          curam.util.exception.InformationalException

Presentation layer operation to list employment working hour records.

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

searchIndigenousGroup

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.IndigenousGroupList searchIndigenousGroup(curam.core.facade.struct.IndigenousGroupSearchKey key)
                                                                                         throws curam.util.exception.AppException,
                                                                                                curam.util.exception.InformationalException

Returns the list of indigenous group based on the key.

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

readEmploymentWorkingHour

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadEmploymentWorkingHourDetails readEmploymentWorkingHour(curam.core.facade.struct.EmploymentWorkingHourKey key)
                                                                                                          throws curam.util.exception.AppException,
                                                                                                                 curam.util.exception.InformationalException

Presentation layer operation to read an employment working hour record.

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

readEmploymentWorkingHourContextDescription

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.EmploymentWorkingHourContextDescription readEmploymentWorkingHourContextDescription(curam.core.facade.struct.EmploymentWorkingHourContextDescriptionKey key)
                                                                                                                                   throws curam.util.exception.AppException,
                                                                                                                                          curam.util.exception.InformationalException

Returns the employment working hour context description.

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

cancelUtilityPayment

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

Cancels a utility payment for a person.

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

listCitizenshipHistory

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadCitizenshipHistoryList listCitizenshipHistory(curam.core.facade.struct.ReadCitizenshipHistoryListKey key)
                                                                                                 throws curam.util.exception.AppException,
                                                                                                        curam.util.exception.InformationalException

Method returns a list of Citizenship Snapshot summary details.

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

listEducationHistory

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadEducationHistoryList listEducationHistory(curam.core.facade.struct.ReadEducationHistoryListKey key)
                                                                                             throws curam.util.exception.AppException,
                                                                                                    curam.util.exception.InformationalException

Method returns a list of Education Snapshot summary details.

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

listAlternativeNameHistory

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadPersonNameHistoryList listAlternativeNameHistory(curam.core.facade.struct.ReadPersonNameHistoryListKey key)
                                                                                                    throws curam.util.exception.AppException,
                                                                                                           curam.util.exception.InformationalException

Method returns a list of Alternative Name Snapshot details.

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

listForeignResidencyHistory

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadPersonForeignResidencyHistoryList listForeignResidencyHistory(curam.core.facade.struct.ReadPersonForeignResidencyHistoryListKey key)
                                                                                                                 throws curam.util.exception.AppException,
                                                                                                                        curam.util.exception.InformationalException

Method returns a list of Foreign Residency Snapshot details.

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

listEmploymentWorkingHourHistory

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadEmploymentWorkingHourHistoryList listEmploymentWorkingHourHistory(curam.core.facade.struct.ReadEmploymentWorkingHourHistoryListKey key)
                                                                                                                     throws curam.util.exception.AppException,
                                                                                                                            curam.util.exception.InformationalException

Method returns a list of Employment Working Hour Snapshot details.

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

listEmploymentHistory

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadEmploymentHistoryList listEmploymentHistory(curam.core.facade.struct.ReadEmploymentHistoryListKey key)
                                                                                               throws curam.util.exception.AppException,
                                                                                                      curam.util.exception.InformationalException

Method returns a list of Employment Snapshot details.

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

listRelationshipHistory

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadRelationshipHistoryList listRelationshipHistory(curam.core.facade.struct.ReadRelationshipHistoryListKey key)
                                                                                                   throws curam.util.exception.AppException,
                                                                                                          curam.util.exception.InformationalException

Method returns a list of Relationship snapshot details.

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

listPersonHistory

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadPersonHistoryList listPersonHistory(curam.core.facade.struct.ReadPersonHistoryListKey key)
                                                                                       throws curam.util.exception.AppException,
                                                                                              curam.util.exception.InformationalException

Method returns a list of Person snapshot details.

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

listRace

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

Returns the list of races to be displayed as a multi select dropdown

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

readInformationalMessage

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.InformationalMsgDetailsList readInformationalMessage(curam.core.facade.struct.MaintainConcernRoleKey key)
                                                                                                    throws curam.util.exception.AppException,
                                                                                                           curam.util.exception.InformationalException

This method is used to read the information message. It takes concernRoleID as an input and return informationalMsgDtls struct.

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

listEmploymentWorkingHourAndVersionNo

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.EmploymentWorkingHourAndVersionNoList listEmploymentWorkingHourAndVersionNo(curam.core.facade.struct.ListEmploymentWorkingHourKey key)
                                                                                                                           throws curam.util.exception.AppException,
                                                                                                                                  curam.util.exception.InformationalException

Presentation layer operation to list employment working hour records.

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

searchCase1

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.SearchCaseDetails1 searchCase1(curam.core.facade.struct.SearchCaseKey_fo key)
                                                                              throws curam.util.exception.AppException,
                                                                                     curam.util.exception.InformationalException

Searches for cases for the specified person.

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

searchCaseForDuplicate1

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.SearchCasesForDuplicateDetails1 searchCaseForDuplicate1(curam.core.facade.struct.SearchCaseKey_fo key)
                                                                                                       throws curam.util.exception.AppException,
                                                                                                              curam.util.exception.InformationalException

Searches for cases for the specified duplicate person and also returns a link to the case list for the original person.

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

cancelAddress

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

This method will change the record status of the Address record from Active to Canceled.

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

cancelAlternateID

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

This method will change the recordStatus of ConcernRoleAlternateID from Active to Cancel.

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

cancelBankAccount

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

This method will change the record Status of BankAccount from Active to Canceled

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

cancelCommunicationException

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

This method will change the recordStatus of Communication Exception from Active to cancel.

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

cancelContact

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

This method modifies the status of the specified contact to 'Cancelled'. Called by caseworker during case processing.

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

cancelEmailAddress

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

This method will change the recordStatus of EmailAddress from Active to cancel.

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

cancelNote

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

This method will change the recordStatus of a participant note to 'cancelled'.

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

cancelParticipantBankAccount

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

This method will change the record Status of Bank Account from Active to Cancelled.

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

cancelPhoneNumber

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

Cancels the specified phone number for the participant.

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

cancelWebAddress

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

This method will change the recordStatus of a concern role web address to 'cancelled'.

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

createAddress

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.CreateParticipantAddressDetails createAddress(curam.core.facade.struct.MaintainParticipantAddressDetails details)
                                                                                             throws curam.util.exception.AppException,
                                                                                                    curam.util.exception.InformationalException

This method creates a new address record for the specified concern role.

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

createAdministrator

@AccessLevel(value=EXTERNAL)
void createAdministrator(curam.core.facade.struct.ParticipantAdministratorDetails participantAdministratorDetails)
                                               throws curam.util.exception.AppException,
                                                      curam.util.exception.InformationalException

This method creates a new administrator for the concern role.

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

createAlternateID

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.CreateParticipantAlternateIDDetails createAlternateID(curam.core.facade.struct.MaintainParticipantAlternateIDDetails details)
                                                                                                     throws curam.util.exception.AppException,
                                                                                                            curam.util.exception.InformationalException

Creates a new alternate ID for a concern role.

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

createCommunicationException

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

Creates a communication exception record for the specified concern role.

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

createContact

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

This method creates a concern role contact based on information supplied by the caseworker during processing.

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

createContactFromUnregisteredParticipant

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

Creates a contact record for a participant who was not previously registered.

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

createEmailAddress

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.CreateParticipantEmailAddressDetails createEmailAddress(curam.core.facade.struct.MaintainParticipantEmailAddressDetails details)
                                                                                                       throws curam.util.exception.AppException,
                                                                                                              curam.util.exception.InformationalException

This method creates a new email address entry for the specified concern role.

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

createHomePhoneNumber

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

This method creates a home phone number for a participant based on details supplied by the caseworker during case processing.

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

createMailingAddress

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

This method creates a mailing address for a participant based on address details supplied by the caseworker during case processing.

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

createNote

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

Creates a new note for the specified participant.

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

createPhoneNumber

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.CreateParticipantPhoneDetails createPhoneNumber(curam.core.facade.struct.MaintainParticipantPhoneDetails details)
                                                                                               throws curam.util.exception.AppException,
                                                                                                      curam.util.exception.InformationalException

Creates a new phone number for the specified participant. Returns any relevant validation information.

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

createWebAddress

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

This method creates a web address for a participant based on details supplied by the caseworker during case processing.

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

createWorkPhoneNumber

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

This method creates a work phone number for a participant based on details supplied by the caseworker during case processing.

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

displaySingleLineAddress

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.AddressString displaySingleLineAddress(curam.core.struct.OtherAddressData otherAddressData)
                                                                                      throws curam.util.exception.AppException,
                                                                                             curam.util.exception.InformationalException

Display the address given as a single line.

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

endDeduction

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

Adds an end date to any active third party deductions for a participant who has been ended.

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

formatBankAcDetailsString

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.BankAccountString formatBankAcDetailsString(curam.core.struct.BankAccountRMDtls details)
                                                                                           throws curam.util.exception.AppException,
                                                                                                  curam.util.exception.InformationalException

Formats the bank account details for a participant. The bank details are formatted to display as a single line of text.

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

insertPrimaryResidenceAddress

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

This method creates a primary residence address for a participant based on details supplied by the caseworker during case processing.

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

listActiveAddresses

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadParticipantActiveAddressList listActiveAddresses(curam.core.facade.struct.ReadParticipantAddressListKey key)
                                                                                                    throws curam.util.exception.AppException,
                                                                                                           curam.util.exception.InformationalException

This method retrieves a list of active address details for the specified concern role.

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

listActiveBankAccount

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadActiveBankAccountList listActiveBankAccount(curam.core.facade.struct.ReadParticipantBankAccountListKey key)
                                                                                               throws curam.util.exception.AppException,
                                                                                                      curam.util.exception.InformationalException

Returns a list of active accounts for a participant.

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

listAddress

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadParticipantAddressList listAddress(curam.core.facade.struct.ReadParticipantAddressListKey key)
                                                                                      throws curam.util.exception.AppException,
                                                                                             curam.util.exception.InformationalException

This method retrieves a list of address details for the specified concern role.

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

listAddressHistory

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadAddressHistoryList listAddressHistory(curam.core.facade.struct.ReadAddressHistoryListKey key)
                                                                                         throws curam.util.exception.AppException,
                                                                                                curam.util.exception.InformationalException

Method returns a list of ConcernRole Address snapshot details.

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

listAddressString

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ParticipantAddressStringList listAddressString(curam.core.facade.struct.ReadParticipantAddressListKey key)
                                                                                              throws curam.util.exception.AppException,
                                                                                                     curam.util.exception.InformationalException

This method retrieves a list of address string details for the specified concern role.

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

listAdministrators

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ParticipantAdministratorDetailsList listAdministrators(curam.core.facade.struct.ReadParticipantAdminRoleListKey readParticipantAdminRoleListKey)
                                                                                                      throws curam.util.exception.AppException,
                                                                                                             curam.util.exception.InformationalException

This method retrieves all the administrators for the given concern role.

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

listAdministratorsForDuplicateParticipant

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ParticipantAdministratorDetailsList listAdministratorsForDuplicateParticipant(curam.core.facade.struct.ReadParticipantAdminRoleListKey readParticipantAdminRoleListKey)
                                                                                                                             throws curam.util.exception.AppException,
                                                                                                                                    curam.util.exception.InformationalException

This method retrieves a list of administrators for the specified duplicate concern role.

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

listAlternateID

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadParticipantAlternateIDList listAlternateID(curam.core.facade.struct.ReadParticipantAlternateIDListKey key)
                                                                                              throws curam.util.exception.AppException,
                                                                                                     curam.util.exception.InformationalException

Retrieves a list of alternate ID's for this concern role.

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

listAlternateIDHistory

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadParticipantAltIDHistoryList listAlternateIDHistory(curam.core.facade.struct.ReadParticipantAltIDHistoryListKey key)
                                                                                                      throws curam.util.exception.AppException,
                                                                                                             curam.util.exception.InformationalException

Method returns a list of ConcernRole AlternateID Snapshot details.

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

listAssessments

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ParticipantAssessmentsList listAssessments(curam.core.struct.ConcernRoleKey concernRoleKey)
                                                                                          throws curam.util.exception.AppException,
                                                                                                 curam.util.exception.InformationalException

Returns a list of assessments for the participant.

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

listBankAccount

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadParticipantBankAccountList listBankAccount(curam.core.facade.struct.ReadParticipantBankAccountListKey key)
                                                                                              throws curam.util.exception.AppException,
                                                                                                     curam.util.exception.InformationalException

Retrieves a list of bank accounts for the specified concern role.

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

listBankAccountHistory

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadParticipantBankAcHistoryList listBankAccountHistory(curam.core.facade.struct.ReadParticipantBankAcHistoryListKey key)
                                                                                                       throws curam.util.exception.AppException,
                                                                                                              curam.util.exception.InformationalException

Method returns a list of ConcernRole Bank Account Snapshot details.

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

listBankAccountString

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ParticipantBankAccountStringList listBankAccountString(curam.core.facade.struct.MaintainConcernRoleKey key)
                                                                                                      throws curam.util.exception.AppException,
                                                                                                             curam.util.exception.InformationalException

Lists the details for a bank account in a single string format for the user.

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

listCommunicationException

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadParticipantCommunicationExceptionList listCommunicationException(curam.core.facade.struct.ReadParticipantCommunicationExceptionListKey key)
                                                                                                                    throws curam.util.exception.AppException,
                                                                                                                           curam.util.exception.InformationalException

Retrieves a list of communication exceptions for the specified concern role.

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

listConcernRole

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadParticipantConcernRoleList listConcernRole(curam.core.facade.struct.ReadParticipantConcernRoleKey key)
                                                                                              throws curam.util.exception.AppException,
                                                                                                     curam.util.exception.InformationalException

reads a list of the concerns roles within the organization

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

listConcernRoleForDuplicate

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadDuplicateParticipantConcernRoleList listConcernRoleForDuplicate(curam.core.facade.struct.ReadParticipantConcernRoleKey key)
                                                                                                                   throws curam.util.exception.AppException,
                                                                                                                          curam.util.exception.InformationalException

Retrieves role details for a specified duplicate concern.

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

listContact
```
@Deprecated
 @AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListContactDetails listContact(curam.core.facade.struct.ListContactKey key)
                                                                                           throws curam.util.exception.AppException,
                                                                                                  curam.util.exception.InformationalException
```
Deprecated. Since Curam 6.0 SP3, replaced by #listConcernContact(). The return struct of the current method listContact has an aggregation to the struct ConcernContactRMDtls, the attribute statusCode in the struct ConcernContactRMDtls is modeled with a domain of CONTACTSTATUS code-table, but the corresponding entity attribute ConcernRoleContactDtls.statusCode is modeled with a domain of RECORD_STATUS_CODE. So new method is introduced to return new struct ListConcernContactDetails which has an aggregation to the new struct ConcernContactRMultiDtls where the attribute statusCode is modeled with a domain of RECORD_STATUS_CODE. See release note: CEF-8999.

This method list all contacts for a participant. Called during case processing by a caseworker.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

listDeduction

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

Returns a list of deductions for a participant.

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

listDeductionForDuplicate

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadDuplicateParticipantDeductionList listDeductionForDuplicate(curam.core.facade.struct.ConcernRoleKeyStruct key)
                                                                                                               throws curam.util.exception.AppException,
                                                                                                                      curam.util.exception.InformationalException

Returns a list of deductions for a duplicate participant.

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

listEmailAddress

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadParticipantEmailAddressList listEmailAddress(curam.core.facade.struct.ReadParticipantEmailAddressListKey key)
                                                                                                throws curam.util.exception.AppException,
                                                                                                       curam.util.exception.InformationalException

Retrieves a list of email address details for the specified concern role.

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

listFormattedAddress

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.FormattedAddressList listFormattedAddress(curam.core.facade.struct.ReadParticipantFormattedAddressListKey readParticipantFormattedAddressListKey)
                                                                                         throws curam.util.exception.AppException,
                                                                                                curam.util.exception.InformationalException

Method to return a list of formatted address for a participant.

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

listFormattedBankAccount

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.FormattedBankAccountList listFormattedBankAccount(curam.core.facade.struct.ReadParticipantFormattedBankAccountListKey readParticipantFormattedBankAccountListKey)
                                                                                                 throws curam.util.exception.AppException,
                                                                                                        curam.util.exception.InformationalException

Method to return a list of formatted Bank Accounts.

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

listInteraction

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListInteractionDetails listInteraction(curam.core.facade.struct.ListInteractionKey key)
                                                                                      throws curam.util.exception.AppException,
                                                                                             curam.util.exception.InformationalException

This method returns a list of client interactions details. Called by caseworker during case processing.

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

listInteractionForDuplicate

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListDuplicateParticipantInteractionDetails listInteractionForDuplicate(curam.core.facade.struct.ListInteractionKey key)
                                                                                                                      throws curam.util.exception.AppException,
                                                                                                                             curam.util.exception.InformationalException

Retrieves interaction details for a specified duplicate concern.

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

listInvestigations

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ParticipantInvestigationList listInvestigations(curam.core.facade.struct.SearchCaseKey_fo concernRoleKey)
                                                                                               throws curam.util.exception.AppException,
                                                                                                      curam.util.exception.InformationalException

Lists the investigations related to a participant.

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

listIssuedPaymentInstrument

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListParticipantIssuedPaymentInstrument listIssuedPaymentInstrument(curam.core.facade.struct.ConcernRoleKeyStruct key)
                                                                                                                  throws curam.util.exception.AppException,
                                                                                                                         curam.util.exception.InformationalException

Returns a list of issued payment instruments for a concern, and also for when the concern is the nominee.

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

listIssuedPaymentInstrumentForDuplicate

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListDuplicateParticipantIssuedPaymentInstrument listIssuedPaymentInstrumentForDuplicate(curam.core.facade.struct.ConcernRoleKeyStruct key)
                                                                                                                                       throws curam.util.exception.AppException,
                                                                                                                                              curam.util.exception.InformationalException

Returns a list of issued payment instruments for a duplicate concern..

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

listParticipantFinancial1

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListParticipantFinancials1 listParticipantFinancial1(curam.core.facade.struct.ListParticipantFinancialsKey key)
                                                                                                    throws curam.util.exception.AppException,
                                                                                                           curam.util.exception.InformationalException

COMMENTS=Returns a list of financials for a participant.

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

listParticipantFinancialForDuplicate

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListDuplicateParticipantFinancials listParticipantFinancialForDuplicate(curam.core.facade.struct.ListParticipantFinancialsKey key)
                                                                                                                       throws curam.util.exception.AppException,
                                                                                                                              curam.util.exception.InformationalException

Returns a list of financials for a duplicate participant.

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

listParticipantTask

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.TasksForConcernAndCaseDetails listParticipantTask(curam.core.facade.struct.ListParticipantTaskKey_eo key)
                                                                                                 throws curam.util.exception.AppException,
                                                                                                        curam.util.exception.InformationalException

Returns a list of tasks for a participant.

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

listParticipantTaskForDuplicate

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.TasksForDuplicateConcernAndCaseDetails listParticipantTaskForDuplicate(curam.core.facade.struct.ListParticipantTaskKey_eo key)
                                                                                                                      throws curam.util.exception.AppException,
                                                                                                                             curam.util.exception.InformationalException

Returns a list of tasks for a duplicate participant.

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

listPhoneNumber

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadParticipantPhoneNumberList listPhoneNumber(curam.core.facade.struct.ReadParticipantPhoneNumberListKey key)
                                                                                              throws curam.util.exception.AppException,
                                                                                                     curam.util.exception.InformationalException

Returns a list of phone numbers for the participant, along with a context description.

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

listScreeningCases

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ParticipantScreeningList listScreeningCases(curam.core.facade.struct.SearchCaseKey_fo key)
                                                                                           throws curam.util.exception.AppException,
                                                                                                  curam.util.exception.InformationalException

Lists all screening cases for a participant.

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

listTemplateByTypeAndParticipant

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListTemplateByTypeAndParticpant listTemplateByTypeAndParticipant(curam.core.facade.struct.ListTemplateByTypeAndParticipantKey key)
                                                                                                                throws curam.util.exception.AppException,
                                                                                                                       curam.util.exception.InformationalException

Returns a list of templates for a particular type and participant.

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

listWebAddress

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ParticipantWebAddressList listWebAddress(curam.core.facade.struct.ParticipantWebAddressListKey key)
                                                                                        throws curam.util.exception.AppException,
                                                                                               curam.util.exception.InformationalException

Retrieves a list of web address details for the specified concern role.

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

modifyAddress

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ModifiedAddressDetails modifyAddress(curam.core.facade.struct.MaintainParticipantAddressDetails details)
                                                                                    throws curam.util.exception.AppException,
                                                                                           curam.util.exception.InformationalException

This method modifies existing address information for the concern role.

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

modifyAlternateID

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ModifiedAlternateIDDetails modifyAlternateID(curam.core.facade.struct.MaintainParticipantAlternateIDDetails details)
                                                                                            throws curam.util.exception.AppException,
                                                                                                   curam.util.exception.InformationalException

Modifies an existing concern role alternate ID returning any details that may exist.

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

modifyCommunicationException

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

Modifies an existing communication exception for the specified concern role.

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

modifyContact
```
@Deprecated
 @AccessLevel(value=EXTERNAL)
void modifyContact(curam.core.facade.struct.ModifyContactDetails details)
                                                      throws curam.util.exception.AppException,
                                                             curam.util.exception.InformationalException
```
Deprecated. Since Curam 6.0 SP3, replaced by #modifyConcernContact(). The parameter struct of the current method modifyContact has an aggregation to the struct ConcernContactDtls, the attribute statusCode in the struct ConcernContactDtls is modeled with a domain of CONTACTSTATUS code-table, but the corresponding entity attribute ConcernRoleContactDtls.statusCode is modeled with a domain of RECORD_STATUS_CODE. So new method is introduced to have new parameter ModifyConcernContactDetails which has an aggregation to the new struct ConcernContactRMultiDtls where the attribute statusCode is modeled with a domain of RECORD_STATUS_CODE. See release note: CEF-8999.

This method modifies a contact for a participant. Called during case processing by a caseworker.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

modifyEmailAddress

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

This method modifies an existing email address of the specified concern role.

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

modifyPhoneNumber

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

Modifies an existing phone number for the participant.

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

modifySentCommunication

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

Modifies the details of a sent communication.

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

modifyWebAddress

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

This method modifies an existing web address of the specified concern role.

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

printCommunication

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

Prints a communication.

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

readAddress

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadParticipantAddressDetails readAddress(curam.core.facade.struct.ReadParticipantAddressKey key)
                                                                                         throws curam.util.exception.AppException,
                                                                                                curam.util.exception.InformationalException

This method retrieves address details for a specified concern role address.

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

readAlternateID

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadParticipantAlternateIDDetails readAlternateID(curam.core.facade.struct.ReadParticipantAlternateIDKey key)
                                                                                                 throws curam.util.exception.AppException,
                                                                                                        curam.util.exception.InformationalException

Retrieves the details of the specified alternate ID.

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

readBankAccount

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadParticipantBankAccountDetails readBankAccount(curam.core.facade.struct.ReadParticipantBankAccountKey key)
                                                                                                 throws curam.util.exception.AppException,
                                                                                                        curam.util.exception.InformationalException

Retrieves bank account details for the concern role.

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

readCommunicationAttachment

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadCommunicationAttachmentDetails readCommunicationAttachment(curam.core.facade.struct.ReadAttachmentKey key)
                                                                                                              throws curam.util.exception.AppException,
                                                                                                                     curam.util.exception.InformationalException

Method to return communication attachment details.

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

readCommunicationException

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadParticipantCommunicationExceptionDetails readCommunicationException(curam.core.facade.struct.ReadParticipantCommunicationExceptionKey key)
                                                                                                                       throws curam.util.exception.AppException,
                                                                                                                              curam.util.exception.InformationalException

Retrieves the details of a specified communication exception.

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

readConcernRoleType

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ConcernRoleTypeDetails readConcernRoleType(curam.core.facade.struct.ReadParticipantConcernRoleKey key)
                                                                                          throws curam.util.exception.AppException,
                                                                                                 curam.util.exception.InformationalException

Reads the concern role type for a participant.

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

readContact
```
@Deprecated
 @AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadContactDetails readContact(curam.core.facade.struct.ReadContactKey key)
                                                                                           throws curam.util.exception.AppException,
                                                                                                  curam.util.exception.InformationalException
```
Deprecated. Since Curam 6.0 SP3, replaced by #readConcernContact(). The return struct of the current method readContact has an aggregation to the struct ConcernContactDtls, the attribute statusCode in the struct ConcernContactDtls is modeled with a domain of CONTACTSTATUS code-table, but the corresponding entity attribute ConcernRoleContactDtls.statusCode is modeled with a domain of RECORD_STATUS_CODE. So new method is introduced to return new struct ReadConcernContactDetails which has an aggregation to the new struct ConcernContactRMultiDtls where the attribute statusCode is modeled with a domain of RECORD_STATUS_CODE. See release note: CEF-8999.

This method returns details of a contact for a participant. Called during case processing by a caseworker.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

readContextDescription

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ParticipantContextDetails readContextDescription(curam.core.facade.struct.ParticipantContextKey key)
                                                                                                throws curam.util.exception.AppException,
                                                                                                       curam.util.exception.InformationalException

Retrieves a context description for the specified participant.

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

readEmailAddress

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadParticipantEmailAddressDetails readEmailAddress(curam.core.facade.struct.ReadParticipantEmailAddressKey key)
                                                                                                   throws curam.util.exception.AppException,
                                                                                                          curam.util.exception.InformationalException

Retrieves the details of the specified email address.

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

readInteraction

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadInteractionDetails readInteraction(curam.core.facade.struct.ReadInteractionKey key)
                                                                                      throws curam.util.exception.AppException,
                                                                                             curam.util.exception.InformationalException

This method retrieves a person's interaction details. Called during case processing by a caseworker.

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

readParticipantContactContextDescription

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ContactContextDescriptionDetails readParticipantContactContextDescription(curam.core.facade.struct.ContactContextDescriptionKey key)
                                                                                                                         throws curam.util.exception.AppException,
                                                                                                                                curam.util.exception.InformationalException

Reads the description of the Contact.

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

readPhoneNumber

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadParticipantPhoneNumberDetails readPhoneNumber(curam.core.facade.struct.ReadParticipantPhoneNumberKey key)
                                                                                                 throws curam.util.exception.AppException,
                                                                                                        curam.util.exception.InformationalException

Retrieves details of the specified phone number for the participant, along with a context description.

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

readWebAddress

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadParticipantWebAddressDetails readWebAddress(curam.core.facade.struct.ParticipantWebAddressKey key)
                                                                                               throws curam.util.exception.AppException,
                                                                                                      curam.util.exception.InformationalException

Retrieves the details of the specified web address.

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

removeAddress

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

This method removes the specified address details for the concern role.

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

resolveProspectHome

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

Resolves the participant home page based on the key

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

updateBankAccountPaymentDetails

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

Allows the user to select a new bank account that all future benefit payments will be paid to.

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

listDeduction1

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadParticipantDeductionList1 listDeduction1(curam.core.facade.struct.ConcernRoleKeyStruct key)
                                                                                            throws curam.util.exception.AppException,
                                                                                                   curam.util.exception.InformationalException

Returns a list of deductions for a participant.

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

listCommunication

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

To list all communications for a participant. Indicators and the fields required to display the actions for the list items in the list row menu are also returned.

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

listActiveBankAccountForRedirection1

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.BankAccountListForRedirectionDetails listActiveBankAccountForRedirection1(curam.core.facade.struct.ParticipantBankAccountRedirectionKey1 key)
                                                                                                                         throws curam.util.exception.AppException,
                                                                                                                                curam.util.exception.InformationalException

Method to list all active bank accounts for a Participant bank account redirection.

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

createBankAccountWithTextSortCode

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.CreateParticipantBankAccountDetails createBankAccountWithTextSortCode(curam.core.facade.struct.MaintainParticipantBankAccountWithTextSortCodeDetails details)
                                                                                                                     throws curam.util.exception.AppException,
                                                                                                                            curam.util.exception.InformationalException

Creates a new bank account for the specified concern role.

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

modifyBankAccountWithTextSortCode

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

Modifies an existing bank account for the specified concern role.

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

modifyNote1

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

Modifies an existing note for the specified concern role.

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

readPersonEvidence

@AccessLevel(value=EXTERNAL)
curam.core.struct.ReadPersonEvidenceDetails readPersonEvidence(curam.core.facade.struct.ReadPersonKey key)
                                                                                     throws curam.util.exception.AppException,
                                                                                            curam.util.exception.InformationalException

Reads the person's evidence details.

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

readClientEvidence

@AccessLevel(value=EXTERNAL)
curam.core.struct.ReadClientEvidenceDetails readClientEvidence(curam.core.facade.struct.ReadPersonKey key)
                                                                                     throws curam.util.exception.AppException,
                                                                                            curam.util.exception.InformationalException

Reads the client's evidence details.

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

modifyPersonEvidence

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.InformationalMsgDetailsList modifyPersonEvidence(curam.core.struct.ModifyPersonEvidenceDetails details)
                                                                                                throws curam.util.exception.AppException,
                                                                                                       curam.util.exception.InformationalException

Presentation layer operation to update a persons evidence details returning informational message details.

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

modifyClientEvidence

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.InformationalMsgDetailsList modifyClientEvidence(curam.core.struct.ModifyClientEvidenceDetails details)
                                                                                                throws curam.util.exception.AppException,
                                                                                                       curam.util.exception.InformationalException

Presentation layer operation to update a clients evidence details returning informational message details.

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

readNote1

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadParticipantNoteDetails1 readNote1(curam.core.facade.struct.ParticipantNoteKey key)
                                                                                     throws curam.util.exception.AppException,
                                                                                            curam.util.exception.InformationalException

Retrieves the details of the specified participant note.

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

listNote1

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

Retrieves a list of notes details for the specified participant.

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

listEmployment1
```
@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadEmploymentDetailsWithMsgList listEmployment1(curam.core.facade.struct.ReadPersonEmploymentListKey key)
                                                                                                throws curam.util.exception.AppException,
                                                                                                       curam.util.exception.InformationalException
```
COMMENTS="This method replaces the deprecated method listEmployment(ReadPersonEmploymentListKey). This method is intended to be used by users responsible for management of employment records for a Person. This method lists all the employment records which belongs to the specified person. It also displays an informational message if the end date has passed on the primary employment record. "

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

readPersonEvidenceForModify

@AccessLevel(value=EXTERNAL)
curam.core.struct.ReadPersonEvidenceDetails readPersonEvidenceForModify(curam.core.facade.struct.ReadPersonKey key)
                                                                                              throws curam.util.exception.AppException,
                                                                                                     curam.util.exception.InformationalException

Reads the person's evidence details.

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

listWaitList

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ConcernRoleWaitListStructList listWaitList(curam.core.struct.ConcernRoleKey key)
                                                                                          throws curam.util.exception.AppException,
                                                                                                 curam.util.exception.InformationalException

This method is intended to be used by the case worker user role for listing the open wait list entries for a Person.

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

readHomePageDetailsShowTasks

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadPersonHomeDetailsShowTasks readHomePageDetailsShowTasks(curam.core.facade.struct.ReadPersonHomeKey key)
                                                                                                           throws curam.util.exception.AppException,
                                                                                                                  curam.util.exception.InformationalException

Presentation layer operation to retrieve home page information for a person.

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

searchPerson

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.PersonSearchDetailsResult searchPerson(curam.core.facade.struct.PersonSearchKey1 key)
                                                                                      throws curam.util.exception.AppException,
                                                                                             curam.util.exception.InformationalException

Search person details by provided search criteria.

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

searchPersonForPopup

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.PersonSearchDetailsResult searchPersonForPopup(curam.core.facade.struct.PersonSearchKey1 key)
                                                                                              throws curam.util.exception.AppException,
                                                                                                     curam.util.exception.InformationalException

Search persons details by provided search criteria. This is used for popup pages and does not return names as hyperlinks.

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

searchPersonWithoutProspectForPopup

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.PersonSearchDetailsResult searchPersonWithoutProspectForPopup(curam.core.facade.struct.PersonSearchKey1 key)
                                                                                                             throws curam.util.exception.AppException,
                                                                                                                    curam.util.exception.InformationalException

Search persons details by provided search criteria. Excludes prospect persons. This is used for popup pages and does not return names as hyperlinks.

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

searchParticipantDetails

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.AllParticipantSearchDetails searchParticipantDetails(curam.core.facade.struct.AllParticipantSearchKey key)
                                                                                                    throws curam.util.exception.AppException,
                                                                                                           curam.util.exception.InformationalException

Searches for all participants by specified search criteria.

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

listConcernContact

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListConcernContactDetails listConcernContact(curam.core.facade.struct.ListContactKey key)
                                                                                            throws curam.util.exception.AppException,
                                                                                                   curam.util.exception.InformationalException

This method list all contacts for a participant. Called during case processing by a caseworker.

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

modifyConcernContact

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

This method modifies a contact for a participant. Called during case processing by a caseworker.

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

readConcernContact

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadConcernContactDetails readConcernContact(curam.core.facade.struct.ReadContactKey key)
                                                                                            throws curam.util.exception.AppException,
                                                                                                   curam.util.exception.InformationalException

This method returns details of a contact for a participant. Called during case processing by a caseworker.

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

searchByReferenceNumber

curam.core.struct.PersonReadDtlsList searchByReferenceNumber(curam.core.facade.struct.PersonAlternateIDSearchKey key)
                                                      throws curam.util.exception.AppException,
                                                             curam.util.exception.InformationalException

Searched people by the specified primary alternate id.

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

readPersonDetails

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

Reads the details of the specified person.

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

Interface Person

Method Summary

Method Detail

createCitizenship

modifyCitizenship

readCitizenship

cancelCitizenship

listCitizenship

readByReferenceNumber

readFurtherDetails

createAlternativeName

modifyAlternativeName

listAlternativeName

readAlternativeName

cancelAlternativeName

createEducation

modifyEducation

readEducation

listEducation

cancelEducation

createEmployment

modifyEmployment

readEmployment

cancelEmployment

createForeignResidency

modifyForeignResidency

readForeignResidency

listForeignResidency

cancelForeignResidency

modifyPerson

createRelationship

modifyRelationship

readRelationship

listRelationship

cancelRelationship

modifyUtilityPayment

readUtilityPayment

listUtilityPayment

readHomePageDetails

register

readPerson

listAllCases

readFullNameAndAddress

listActiveBenefitCase

cancelEmploymentWorkingHour

createEmploymentWorkingHour

modifyEmploymentWorkingHour

listEmploymentWorkingHour

searchIndigenousGroup

readEmploymentWorkingHour

readEmploymentWorkingHourContextDescription

cancelUtilityPayment

listCitizenshipHistory

listEducationHistory

listAlternativeNameHistory

listForeignResidencyHistory

listEmploymentWorkingHourHistory

listEmploymentHistory

listRelationshipHistory

listPersonHistory

listRace

readInformationalMessage

listEmploymentWorkingHourAndVersionNo

searchCase1

searchCaseForDuplicate1

cancelAddress

cancelAlternateID

cancelBankAccount

cancelCommunicationException

cancelContact

cancelEmailAddress

cancelNote

cancelParticipantBankAccount

cancelPhoneNumber

cancelWebAddress

createAddress

createAdministrator

createAlternateID

createCommunicationException

createContact