ProspectEmployer (core)

All Known Implementing Classes:

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

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`associateProspectWithRegisteredEmployer(curam.core.facade.struct.ReadProspectEmployerHomeDetails employerConcernRoleKey)` This method associates the current Prospect Employer to the selected Registered Employer record.
`curam.core.facade.struct.ProspectEmployerRegistrationDetails`	`autoPopulateRegistrationFields(curam.core.facade.struct.ProspectEmployerKey key)` This method auto populates the relevant fields on the Register Prospect Employer As Employer Page.
`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`	`cancelBankAccount(curam.core.facade.struct.CancelParticipantBankAccountKey key)` This method will change the record Status of BankAccount from Active to Canceled
`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`	`cancelEmailAddress(curam.core.facade.struct.CancelParticipantEmailAddressKey key)` This method will change the recordStatus of EmailAddress from Active to cancel.
`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.CancelEmployerRelationshipKey key)` Cancels an existing relationship for the employer.
`curam.core.facade.struct.TradingStatusMessageList`	`cancelTradingStatus(curam.core.facade.struct.CancelTradingStatusKey key)` Cancels an existing trading status.
`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.CreateParticipantBankAccountDetails`	`createBankAccountWithTextSortCode(curam.core.facade.struct.MaintainParticipantBankAccountWithTextSortCodeDetails details)` Creates a new bank account for the specified concern role.
`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.CreateParticipantEmailAddressDetails`	`createEmailAddress(curam.core.facade.struct.MaintainParticipantEmailAddressDetails details)` This method creates a new email address entry for the specified concern role.
`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.MaintainProspectEmployerRelationshipDetails details)` Method to create a relationship between a prospect employer and another company.
`void`	`createTradingStatus(curam.core.facade.struct.MaintainTradingStatusDetails details)` Creates a new trading status entry for the specified employer.
`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.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.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.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.ListCaseDetails`	`listCase(curam.core.facade.struct.ListCaseKey_fo key)` Retrieve list of cases by concern role ID.
`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.ReadParticipantEmailAddressList`	`listEmailAddress(curam.core.facade.struct.ReadParticipantEmailAddressListKey key)` Retrieves a list of email address details for the specified concern role.
`curam.core.facade.struct.ReadEmployerHistoryList`	`listEmployerHistory(curam.core.facade.struct.ReadEmployerHistoryListKey key)` Method returns a list of Employer 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.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.ReadProspectEmployerHistoryList`	`listProspectEmployerHistory(curam.core.facade.struct.ReadProspectEmployerHistoryListKey key)` Method returns a list of Prospect Employer snapshot details.
`curam.core.facade.struct.ReadEmployerRelationshipList`	`listRelationship(curam.core.facade.struct.ReadEmployerRelationshipListKey key)` Retrieves a list of relationships for the employer, along with a context description.
`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.ReadTradingStatusList`	`listTradingStatus(curam.core.facade.struct.ReadTradingStatusListKey key)` Retrieves a list of trading status entries for the specified employer, along with a context description.
`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.InformationMsgDtlsList`	`modifyBankAccountWithTextSortCode(curam.core.facade.struct.MaintainParticipantBankAccountWithTextSortCodeDetails details)` Modifies an existing bank account for the specified concern role.
`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.
`void`	`modifyEmailAddress(curam.core.facade.struct.MaintainParticipantEmailAddressDetails details)` This method modifies an existing email address of the specified concern role.
`curam.core.facade.struct.ModifyEmployerReturnDetails`	`modifyEmployer(curam.core.facade.struct.ModifyEmployerDetails details)` Updates an employer with new details.
`void`	`modifyNote1(curam.core.facade.struct.ModifyParticipantNoteDetails1 details)` Modifies an existing note for the specified concern role.
`void`	`modifyPhoneNumber(curam.core.facade.struct.MaintainParticipantPhoneDetails details)` Modifies an existing phone number for the participant.
`curam.core.facade.struct.ModifyEmployerReturnDetails`	`modifyProspectEmployer(curam.core.facade.struct.ModifyEmployerDetails details)` Updates a prospect employer with new details
`curam.core.facade.struct.ModifiedRelationshipDetails`	`modifyRelationship(curam.core.facade.struct.MaintainProspectEmployerRelationshipDetails details)` Method to modify the details of the relationship between a prospect employer and another company.
`void`	`modifySentCommunication(curam.core.facade.struct.ModifySentCommunicationDetails details)` Modifies the details of a sent communication.
`curam.core.facade.struct.TradingStatusMessageList`	`modifyTradingStatus(curam.core.facade.struct.MaintainTradingStatusDetails details)` Modifies an existing trading status entry for the specified employer.
`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.ReadParticipantBankAccountDetails`	`readBankAccount(curam.core.facade.struct.ReadParticipantBankAccountKey key)` Retrieves bank account details for the concern role.
`curam.core.facade.struct.EmployerReadDetails`	`readByReferenceNumber(curam.core.facade.struct.EmployerAlternateSearchKey key)` Retrieves name and address details for an employer, specified by alternative reference number.
`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.ReadParticipantEmailAddressDetails`	`readEmailAddress(curam.core.facade.struct.ReadParticipantEmailAddressKey key)` Retrieves the details of the specified email address.
`curam.core.facade.struct.ReadEmployerDetailsDetails`	`readEmployerDetails(curam.core.facade.struct.ReadEmployerDetailsKey key)` Retrieves details for the specified employer.
`curam.core.facade.struct.EmployerNameAndAddressDetails`	`readFullNameAndAddress(curam.core.facade.struct.ReadEmployerDetailsKey key)` Reads the employer's full name and address.
`curam.core.facade.struct.ReadProspectEmployerHomeDetails`	`readHomePageDetails(curam.core.facade.struct.ProspectEmployerKey key)` Retrieves details to be displayed on a home page for a prospect employer
`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.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.ReadEmployerDetailsDetails`	`readProspectEmployerDetails(curam.core.facade.struct.ReadEmployerDetailsKey key)` Method to read the details of a Prospect Employer who is registered on the system.
`curam.core.facade.struct.ReadEmployerRelationshipDetails`	`readRelationship(curam.core.facade.struct.ReadEmployerRelationshipKey key)` Retrieves details of the specified relationship, along with a context description for the employer.
`curam.core.facade.struct.ReadTradingStatusDetails`	`readTradingStatus(curam.core.facade.struct.ReadTradingStatusKey key)` Retrieves details of an existing trading status, along with a context description for the employer.
`curam.core.facade.struct.ReadParticipantWebAddressDetails`	`readWebAddress(curam.core.facade.struct.ParticipantWebAddressKey key)` Retrieves the details of the specified web address.
`curam.core.facade.struct.EmployerRegistrationResult`	`register(curam.core.facade.struct.EmployerRegistrationDetails details)` Registers a new employer with the organization.
`curam.core.facade.struct.ProspectEmployerRegistrationResult`	`registerProspectEmployer(curam.core.facade.struct.ProspectEmployerRegistrationDetails details)` Registers a new prospect employer with the organization.
`curam.core.facade.struct.ProspectEmployerRegistrationResult`	`registerProspectEmployerAsEmployer(curam.core.facade.struct.ProspectEmployerKey key, curam.core.facade.struct.ProspectEmployerRegistrationDetails details)` Registers an existing prospect employer as an employer with the organization.
`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.facade.struct.ProspectEmployerSearchResult`	`searchCurrentProspectEmployers(curam.core.facade.struct.ProspectEmployerSearchKey key)` Performs a search for prospect employers who have not subsequently been registered as an employer.
`curam.core.facade.struct.EmployerSearchDetailsResult`	`searchEmployerDetails(curam.core.facade.struct.EmployerSearchKey1 key)` Searches for an employer by specified search criteria.
`curam.core.facade.struct.EmployerSearchDetailsResult`	`searchEmployerForPopup(curam.core.facade.struct.EmployerSearchKey1 key)` Searches for an employer by specified search criteria.
`curam.core.facade.struct.AllParticipantSearchDetails`	`searchParticipantDetails(curam.core.facade.struct.AllParticipantSearchKey key)` Searches for all participants by specified search criteria.
`curam.core.facade.struct.ProspectEmployerSearchResult`	`searchProspectEmployers(curam.core.facade.struct.ProspectEmployerSearchKey key)` Performs a search for prospect employers using the specified search criteria, or performs a database read if the alternate ID is specified.
`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

searchProspectEmployers

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ProspectEmployerSearchResult searchProspectEmployers(curam.core.facade.struct.ProspectEmployerSearchKey key)
                                                                                                    throws curam.util.exception.AppException,
                                                                                                           curam.util.exception.InformationalException

Performs a search for prospect employers using the specified search criteria, or performs a database read if the alternate ID is specified. Will not return more records than specified in the EMPLOYERSEARCHMAX environment variable.

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

readHomePageDetails

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

Retrieves details to be displayed on a home page for a prospect employer

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

modifyProspectEmployer

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ModifyEmployerReturnDetails modifyProspectEmployer(curam.core.facade.struct.ModifyEmployerDetails details)
                                                                                                  throws curam.util.exception.AppException,
                                                                                                         curam.util.exception.InformationalException

Updates a prospect employer with new details

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

registerProspectEmployer

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ProspectEmployerRegistrationResult registerProspectEmployer(curam.core.facade.struct.ProspectEmployerRegistrationDetails details)
                                                                                                           throws curam.util.exception.AppException,
                                                                                                                  curam.util.exception.InformationalException

Registers a new prospect employer with the organization. Returns the unique internal identifiers assigned to the prospect employer.

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

registerProspectEmployerAsEmployer

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ProspectEmployerRegistrationResult registerProspectEmployerAsEmployer(curam.core.facade.struct.ProspectEmployerKey key,
                                                                                                                            curam.core.facade.struct.ProspectEmployerRegistrationDetails details)
                                                                                                                     throws curam.util.exception.AppException,
                                                                                                                            curam.util.exception.InformationalException

Registers an existing prospect employer as an employer with the organization. Returns the unique internal identifiers assigned to the employer.

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

readProspectEmployerDetails

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadEmployerDetailsDetails readProspectEmployerDetails(curam.core.facade.struct.ReadEmployerDetailsKey key)
                                                                                                      throws curam.util.exception.AppException,
                                                                                                             curam.util.exception.InformationalException

Method to read the details of a Prospect Employer who is registered on the system.

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

createRelationship

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

Method to create a relationship between a prospect employer and another company. The relationship could, for example, detail a parent and subsidiary company's relationship.

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

modifyRelationship

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

Method to modify the details of the relationship between a prospect employer and another company. The relationship could, for example, detail a parent and subsidiary company's relationship.

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

searchCurrentProspectEmployers

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ProspectEmployerSearchResult searchCurrentProspectEmployers(curam.core.facade.struct.ProspectEmployerSearchKey key)
                                                                                                           throws curam.util.exception.AppException,
                                                                                                                  curam.util.exception.InformationalException

Performs a search for prospect employers who have not subsequently been registered as an employer.

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

autoPopulateRegistrationFields

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ProspectEmployerRegistrationDetails autoPopulateRegistrationFields(curam.core.facade.struct.ProspectEmployerKey key)
                                                                                                                  throws curam.util.exception.AppException,
                                                                                                                         curam.util.exception.InformationalException

This method auto populates the relevant fields on the Register Prospect Employer As Employer Page.

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

listProspectEmployerHistory

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadProspectEmployerHistoryList listProspectEmployerHistory(curam.core.facade.struct.ReadProspectEmployerHistoryListKey key)
                                                                                                           throws curam.util.exception.AppException,
                                                                                                                  curam.util.exception.InformationalException

Method returns a list of Prospect Employer snapshot details.

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

readByReferenceNumber

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

Retrieves name and address details for an employer, specified by alternative reference number.

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

createTradingStatus

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

Creates a new trading status entry for the specified employer.

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

modifyTradingStatus

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.TradingStatusMessageList modifyTradingStatus(curam.core.facade.struct.MaintainTradingStatusDetails details)
                                                                                            throws curam.util.exception.AppException,
                                                                                                   curam.util.exception.InformationalException

Modifies an existing trading status entry for the specified employer. Returns any relevant informational messages.

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

readTradingStatus

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadTradingStatusDetails readTradingStatus(curam.core.facade.struct.ReadTradingStatusKey key)
                                                                                          throws curam.util.exception.AppException,
                                                                                                 curam.util.exception.InformationalException

Retrieves details of an existing trading status, along with a context description for the employer.

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

listTradingStatus

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadTradingStatusList listTradingStatus(curam.core.facade.struct.ReadTradingStatusListKey key)
                                                                                       throws curam.util.exception.AppException,
                                                                                              curam.util.exception.InformationalException

Retrieves a list of trading status entries for the specified employer, along with a context description.

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

cancelTradingStatus

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.TradingStatusMessageList cancelTradingStatus(curam.core.facade.struct.CancelTradingStatusKey key)
                                                                                            throws curam.util.exception.AppException,
                                                                                                   curam.util.exception.InformationalException

Cancels an existing trading status. Returns any relevant informational messages.

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

register

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

Registers a new employer with the organization. Returns the unique internal identifiers assigned to the employer.

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

readRelationship

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

Retrieves details of the specified relationship, along with a context description for the employer.

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

listRelationship

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

Retrieves a list of relationships for the employer, along with a context description.

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

cancelRelationship

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

Cancels an existing relationship for the employer.

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

modifyEmployer

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ModifyEmployerReturnDetails modifyEmployer(curam.core.facade.struct.ModifyEmployerDetails details)
                                                                                          throws curam.util.exception.AppException,
                                                                                                 curam.util.exception.InformationalException

Updates an employer with new details.

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

listCase

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListCaseDetails listCase(curam.core.facade.struct.ListCaseKey_fo key)
                                                                        throws curam.util.exception.AppException,
                                                                               curam.util.exception.InformationalException

Retrieve list of cases by concern role ID.

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

readEmployerDetails

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

Retrieves details for the specified employer.

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

readFullNameAndAddress

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

Reads the employer's full name and address.

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

listEmployerHistory

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadEmployerHistoryList listEmployerHistory(curam.core.facade.struct.ReadEmployerHistoryListKey key)
                                                                                           throws curam.util.exception.AppException,
                                                                                                  curam.util.exception.InformationalException

Method returns a list of Employer Snapshot details.

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

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

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

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

searchEmployerDetails

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.EmployerSearchDetailsResult searchEmployerDetails(curam.core.facade.struct.EmployerSearchKey1 key)
                                                                                                 throws curam.util.exception.AppException,
                                                                                                        curam.util.exception.InformationalException

Searches for an employer by specified search criteria.

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

searchEmployerForPopup

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.EmployerSearchDetailsResult searchEmployerForPopup(curam.core.facade.struct.EmployerSearchKey1 key)
                                                                                                  throws curam.util.exception.AppException,
                                                                                                         curam.util.exception.InformationalException

Searches for an employer by specified search criteria. 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

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

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

associateProspectWithRegisteredEmployer

void associateProspectWithRegisteredEmployer(curam.core.facade.struct.ReadProspectEmployerHomeDetails employerConcernRoleKey)
                                      throws curam.util.exception.AppException,
                                             curam.util.exception.InformationalException

This method associates the current Prospect Employer to the selected Registered Employer record.

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

Interface ProspectEmployer

Method Summary

Method Detail

searchProspectEmployers

readHomePageDetails

modifyProspectEmployer

registerProspectEmployer

registerProspectEmployerAsEmployer

readProspectEmployerDetails

createRelationship

modifyRelationship

searchCurrentProspectEmployers

autoPopulateRegistrationFields

listProspectEmployerHistory

readByReferenceNumber

createTradingStatus

modifyTradingStatus

readTradingStatus

listTradingStatus

cancelTradingStatus

register

readRelationship

listRelationship

cancelRelationship

modifyEmployer

listCase

readEmployerDetails

readFullNameAndAddress

listEmployerHistory

cancelAddress

cancelAlternateID

cancelBankAccount

cancelCommunicationException

cancelContact

cancelEmailAddress

cancelNote

cancelParticipantBankAccount

cancelPhoneNumber

cancelWebAddress

createAddress

createAdministrator

createAlternateID

createCommunicationException

createContact

createContactFromUnregisteredParticipant

createEmailAddress

createHomePhoneNumber

createMailingAddress

createNote

createPhoneNumber

createWebAddress

createWorkPhoneNumber

displaySingleLineAddress

endDeduction

formatBankAcDetailsString

insertPrimaryResidenceAddress

listActiveAddresses

listActiveBankAccount

listAddress

listAddressHistory

listAddressString

listAdministrators

listAdministratorsForDuplicateParticipant

listAlternateID

listAlternateIDHistory

listAssessments

listBankAccount

listBankAccountHistory

listBankAccountString

listCommunicationException

listConcernRole

listConcernRoleForDuplicate

listContact

listDeduction

listDeductionForDuplicate

listEmailAddress

listFormattedAddress

listFormattedBankAccount

listInteraction

listInteractionForDuplicate