curam.application.facade.intf

Interface ApplicationClient

All Known Implementing Classes:

ApplicationClient, curam.application.facade.impl.ApplicationClient, ApplicationClientFactory

public interface ApplicationClient

This business interface provides operations related to clients on an application.

Method Summary

Modifier and Type	Method and Description
void	addClient(curam.application.facade.struct.AddClientDetails key) Creates a new client for the application.This also creates a caseParticipantRole record for the client.
curam.application.facade.struct.InformationalMsgDtlsList	getFindClientPodInformational(curam.application.facade.struct.SearchPersonAndProspectPersonKey key) Retrieves any informational error messages coming from the Find Client Pod.
curam.application.facade.struct.ApplicationClientDetailsList	listClients(curam.application.entity.struct.ApplicationKey key) Retrieves the list of client details associated with the application.
void	modifyClientDetails(curam.application.facade.struct.ModifyClientDetails modifyClientDetails) Modifies the details of a client for an application.
curam.application.facade.struct.ClientWizardDisplayDetails	readAddClientWizardDetails() Get the the wizard details for the the add client page.
curam.application.facade.struct.ApplicationClientDetails	readClientDetails(curam.application.entity.struct.IntakeApplicantKey key) Reads all the client details for the application.
curam.application.facade.struct.ApplicationClientDetailsForModify	readClientDetailsForModify(curam.application.entity.struct.IntakeApplicantKey key) Reads the client details for modification.
curam.struct.ConcernRoleIDKey	registerAParticipantAndAddAsClient(curam.application.facade.struct.RegisterPersonWithApplicantDetails details) Registers new person and add the person as a client on the application.
curam.struct.ConcernRoleIDKey	registerPersonAndAddAsClient(curam.application.facade.struct.RegisterPersonAndApplicantDetails details) Deprecated. Since Curam 6.0.5.1, replaced by curam.application.facade.impl.ApplicationClient#registerAParticipantAndAddAsClient()
void	removeClientFromApplication(curam.application.entity.struct.IntakeApplicantKey key) Removes the client on the application.
curam.application.facade.struct.PersonAndProspectPersonDetailsList	searchPersonAndProspectPersonForClient(curam.application.facade.struct.SearchPersonAndProspectPersonKey key) Retrieves a list of person or prospect persons based on certain search criteria passed in, to add as a client for the application.
curam.application.facade.struct.PersonAndProspectPersonDetailsList	searchPersonAndProspectPersons(curam.application.facade.struct.SearchPersonAndProspectPersonKey key) Retrieves a list of person or prospect persons based on certain search criteria passed in.
curam.application.facade.struct.PersonAndProspectPersonDetailsList	searchPersonAndProspectPersonsForMerge(curam.application.facade.struct.SearchPersonAndProspectPersonKey key) Search for the person to match with a prospect person.
void	validateSearchPersonAndProspecrPerson(curam.application.facade.struct.ValidateSearchPersonAndProspectPersonKey key) Validates the details of the person or prospect person search criteria.

Method Detail

listClients

curam.application.facade.struct.ApplicationClientDetailsList listClients(curam.application.entity.struct.ApplicationKey key)
                                                                  throws curam.util.exception.AppException,
                                                                         curam.util.exception.InformationalException

Retrieves the list of client details associated with the application.

Parameters:

key - System unique identifier for the application.

Returns:

Returns the list of client details.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

readClientDetails

curam.application.facade.struct.ApplicationClientDetails readClientDetails(curam.application.entity.struct.IntakeApplicantKey key)
                                                                    throws curam.util.exception.AppException,
                                                                           curam.util.exception.InformationalException

Reads all the client details for the application.

Parameters:

key - System generated unique identifier for the client.

Returns:

The details of the client.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

searchPersonAndProspectPersons

curam.application.facade.struct.PersonAndProspectPersonDetailsList searchPersonAndProspectPersons(curam.application.facade.struct.SearchPersonAndProspectPersonKey key)
                                                                                           throws curam.util.exception.AppException,
                                                                                                  curam.util.exception.InformationalException

Retrieves a list of person or prospect persons based on certain search criteria passed in.

Parameters:

searchPersonAndProspectPersonKey - Key for searching the person and prospect person details.

Returns:

List of Person and prospect person details.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

registerPersonAndAddAsClient

@Deprecated
curam.struct.ConcernRoleIDKey registerPersonAndAddAsClient(curam.application.facade.struct.RegisterPersonAndApplicantDetails details)
                                                                throws curam.util.exception.AppException,
                                                                       curam.util.exception.InformationalException

Deprecated. Since Curam 6.0.5.1, replaced by curam.application.facade.impl.ApplicationClient#registerAParticipantAndAddAsClient()

Registers new person and add the person as a client on the application.

Parameters:

details - Details of the person to be registered.

Returns:

The concernRoleID of the registered person.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

addClient

void addClient(curam.application.facade.struct.AddClientDetails key)
        throws curam.util.exception.AppException,
               curam.util.exception.InformationalException

Creates a new client for the application.This also creates a caseParticipantRole record for the client.

Parameters:

details - The details of the client to create.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

removeClientFromApplication

void removeClientFromApplication(curam.application.entity.struct.IntakeApplicantKey key)
                          throws curam.util.exception.AppException,
                                 curam.util.exception.InformationalException

Removes the client on the application. In addition will remove the caseParticipantRole record if the client is NOT an active member on another application associated with this application case.

Parameters:

key - Unique identifier for the client record.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

readAddClientWizardDetails

curam.application.facade.struct.ClientWizardDisplayDetails readAddClientWizardDetails()
                                                                               throws curam.util.exception.AppException,
                                                                                      curam.util.exception.InformationalException

Get the the wizard details for the the add client page.

Returns:

Returns the wizard details to display on the add client page

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

validateSearchPersonAndProspecrPerson

void validateSearchPersonAndProspecrPerson(curam.application.facade.struct.ValidateSearchPersonAndProspectPersonKey key)
                                    throws curam.util.exception.AppException,
                                           curam.util.exception.InformationalException

Validates the details of the person or prospect person search criteria.

Parameters:

key - The key containing the details to validate.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

searchPersonAndProspectPersonsForMerge

curam.application.facade.struct.PersonAndProspectPersonDetailsList searchPersonAndProspectPersonsForMerge(curam.application.facade.struct.SearchPersonAndProspectPersonKey key)
                                                                                                   throws curam.util.exception.AppException,
                                                                                                          curam.util.exception.InformationalException

Search for the person to match with a prospect person.

Parameters:

searchPersonAndProspectPersonKey - Key for searching the person and prospect person details.

Returns:

List of person and prospect person details.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

searchPersonAndProspectPersonForClient

curam.application.facade.struct.PersonAndProspectPersonDetailsList searchPersonAndProspectPersonForClient(curam.application.facade.struct.SearchPersonAndProspectPersonKey key)
                                                                                                   throws curam.util.exception.AppException,
                                                                                                          curam.util.exception.InformationalException

Retrieves a list of person or prospect persons based on certain search criteria passed in, to add as a client for the application.

Parameters:

searchPersonAndProspectPersonKey - Key for searching the person and prospect person details.

Returns:

List of Person and prospect person details.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

modifyClientDetails

void modifyClientDetails(curam.application.facade.struct.ModifyClientDetails modifyClientDetails)
                  throws curam.util.exception.AppException,
                         curam.util.exception.InformationalException

Modifies the details of a client for an application.

Parameters:

modifyClientDetails - The details of the client to be modified.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

readClientDetailsForModify

curam.application.facade.struct.ApplicationClientDetailsForModify readClientDetailsForModify(curam.application.entity.struct.IntakeApplicantKey key)
                                                                                      throws curam.util.exception.AppException,
                                                                                             curam.util.exception.InformationalException

Reads the client details for modification.

Parameters:

intakeApplicantKey - System generated unique identifier for the client.

Returns:

The modified details of the client.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

getFindClientPodInformational

curam.application.facade.struct.InformationalMsgDtlsList getFindClientPodInformational(curam.application.facade.struct.SearchPersonAndProspectPersonKey key)
                                                                                throws curam.util.exception.AppException,
                                                                                       curam.util.exception.InformationalException

Retrieves any informational error messages coming from the Find Client Pod.

Parameters:

key - Contains the person and prospect person search criteria.

Returns:

The informational list.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

registerAParticipantAndAddAsClient

curam.struct.ConcernRoleIDKey registerAParticipantAndAddAsClient(curam.application.facade.struct.RegisterPersonWithApplicantDetails details)
                                                          throws curam.util.exception.AppException,
                                                                 curam.util.exception.InformationalException

Registers new person and add the person as a client on the application.

Parameters:

details - Details of the person to be registered.

Returns:

The concernRoleID of the registered person.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException