@AccessLevel(value=EXTERNAL)
public interface ApplicationCase
Modifier and Type | Method and Description |
---|---|
void |
addProgram(curam.commonintake.facade.struct.ApplicationCaseProgramDetails details)
Creates an intake program application record for the program and links it
to the application case.
|
void |
assignToCurrentUser(curam.commonintake.facade.struct.ApplicationCaseKey key)
Assigns the specified application case to the currently logged in user.
|
curam.commonintake.facade.struct.ApplicationCaseMessages |
checkAnyPendingCases(curam.commonintake.facade.struct.ApplicationCaseKey key)
Checks and displays warning message if there are any pending application
cases for any of the list of clients available.
|
curam.commonintake.facade.struct.ApplicationCaseMessages |
checkAnyPendingCasesByProgram(curam.commonintake.facade.struct.ApplicationCaseKey appCaseKey,
curam.commonintake.facade.struct.IntakeProgramKey programKey)
Checks and displays warning message if there are any pending application
cases for any of the list of clients available.
|
curam.commonintake.entity.struct.ApplicationCaseKey |
createApplicationCaseForConcernRole(curam.commonintake.facade.struct.ApplicationCaseCreateDetails details)
Creates an application case with specified concern role details.
|
curam.commonintake.entity.struct.ApplicationCaseKey |
createReferralApplicationCaseForConcernRole(curam.commonintake.facade.struct.ApplicationCaseCreateDetails details)
Creates a referral application case with specified concern role details.
|
curam.commonintake.facade.struct.ApplicationCaseHomepageURI |
getHomepage(curam.commonintake.facade.struct.ApplicationCaseKey key)
Retrieves the configured home page for the specified application case.
|
curam.commonintake.facade.struct.MyProgramsDueFilterCriteria |
getMyProgramsDueFilterCriteria()
Returns the persisted filter criteria for the My Programs Due search.
|
curam.commonintake.facade.struct.ApplicationCaseSearchCriteriaDisplayDetails |
getReferralSearchCriteria()
Returns the search criteria required for display on the client.
|
curam.commonintake.facade.struct.ApplicationCaseSearchCriteriaDisplayDetails |
getSearchCriteria()
Returns the search criteria required for display on the client.
|
curam.commonintake.facade.struct.ApplicationCaseDetailsList |
listApplicationCaseByConcernRole(curam.core.struct.ConcernRoleKey key)
Retrieves a list of all application cases for the specified participant.
|
curam.commonintake.facade.struct.ApplicationCaseDetailsList |
listApplicationCaseByOwner()
Retrieves a list of all application cases for the specified user.
|
curam.commonintake.facade.struct.ApplicationRelatedCaseList |
listClientCases(curam.commonintake.entity.struct.ApplicationCaseKey key)
Retrieves a list of the existing application cases, integrated cases and
product deliveries for which any of the application case clients is a case
participant of type 'Primary Client' or 'Member'.
|
curam.commonintake.facade.struct.ApplicationClientDetailsList |
listClients(curam.commonintake.entity.struct.ApplicationCaseKey key)
Retrieves a list of all clients on the application case.
|
curam.core.facade.struct.ListEventDetails1 |
listMeetings(curam.core.facade.struct.ListEventKey key)
Returns a list of meetings associated with the application case.
|
curam.commonintake.facade.struct.MyApplicationsList |
listMyApplications()
Retrieves a list of all application cases assigned to the currently logged
in user that meet the following criteria.
|
curam.commonintake.facade.struct.MyProgramsDueList |
listMyProgramsDue()
Returns a list of Programs due for applications assigned to the currently
logged in user.
|
curam.commonintake.facade.struct.MyApplicationsList |
listMyReferrals()
Retrieves a list of all referrral application cases assigned to the
currently logged in user that meet the following criteria.
|
curam.commonintake.facade.struct.ApplicationClientDetailsList |
listPotentialMatches(curam.commonintake.facade.struct.ApplicationCaseAndConcernRoleKey key)
Retrieves a list of all inconclusive matches for the client.
|
curam.commonintake.facade.struct.ApplicationClientDetailsList |
listPreviousClients(curam.commonintake.entity.struct.ApplicationCaseKey key)
Retrieves a list of all clients that were previously on the application
case.
|
curam.commonintake.facade.struct.ProgramDetailsList |
listPrograms(curam.commonintake.entity.struct.ApplicationCaseKey key)
Retrieves a list of program details associated to the specified
application case.
|
curam.commonintake.facade.struct.ProgramTypeDetailsList |
listProgramsConfiguredForApplication(curam.commonintake.entity.struct.ApplicationCaseKey key)
Retreives a list of programs configured for the application case.
|
curam.commonintake.facade.struct.ApplicationCaseDetailsList |
listReferralCaseByConcernRole(curam.core.struct.ConcernRoleKey key)
Retrieves a list of all referral application cases for the specified
participant.
|
void |
modifyApplicationDetails(curam.commonintake.facade.struct.ApplicationCaseReadDetails details)
Modifies the application case details.
|
void |
modifyProgramDateAdded(curam.commonintake.facade.struct.ApplicationCaseProgramDetails details)
Updates the program application date.
|
curam.commonintake.facade.struct.ApplicationCaseReadDetails |
readApplicationDetails(curam.commonintake.entity.struct.ApplicationCaseKey key)
Reads the application details to be modified.
|
curam.commonintake.facade.struct.ReferralCaseDetails |
readCaseDetails(curam.commonintake.entity.struct.ApplicationCaseKey arg1)
Reads details of the referral application details.
|
curam.commonintake.facade.struct.ApplicationCaseContextPanelDetails |
readContextPanelDetails(curam.core.struct.CaseHeaderKey key)
Reads the context panel details for the specified application case home
page.
|
curam.commonintake.facade.struct.ApplicationCaseReadDetailsForCreate |
readDetailsForCreate()
Returns the details required for creation of an application case.
|
curam.commonintake.facade.struct.ApplicationCaseProgramDateAddedDetails |
readProgramDateAddedDetails(curam.workspaceservices.intake.struct.IntakeProgramApplicationKey key)
Reads the program details to be be modified.
|
curam.commonintake.facade.struct.RegisterClientDetails |
readProspectPersonDetails(curam.commonintake.facade.struct.ProspectConcernRoleID Key)
Reads prospect person details.
|
curam.commonintake.facade.struct.ReferralApplicationCaseReadDetails |
readReferralApplicationDetails(curam.commonintake.entity.struct.ApplicationCaseKey key)
Reads the referral application details to be modified.
|
curam.commonintake.facade.struct.ApplicationCaseReadDetailsForCreate |
readReferralCreateDetails()
Returns the details required for creation of a referral application case.
|
void |
registerClient(curam.commonintake.facade.struct.RegisterClientDetails dtls)
Registers the client on the system as a registered person and adds them to
the application.
|
void |
registerProspectPerson(curam.commonintake.facade.struct.RegisterClientDetails dtls)
Registers the prospect person as a client on the system.
|
void |
removeClient(curam.commonintake.facade.struct.CaseParticipantRoleAndVersionNo key)
Removes the client from the application case.
|
void |
resubmitApplication(curam.commonintake.facade.struct.ApplicationCaseKey key)
Resubmits the application case when there are no evidence issues exist.
|
curam.commonintake.facade.struct.MyApplicationsList |
search(curam.commonintake.facade.struct.ApplicationCaseSearchCriteria details)
Searches for an application case based on the specified search criteria.
|
curam.commonintake.facade.struct.FindClientList |
searchOrAddClient(curam.commonintake.facade.struct.FindClientKey key)
Searches for a client or adds a client depending on which action is
selected by the user.
|
curam.commonintake.facade.struct.FindClientList |
searchOrMatchClient(curam.commonintake.facade.struct.FindClientKey key)
Searches for a client or performs a client match depending on which action
is selected by the user.
|
curam.commonintake.facade.struct.MyApplicationsList |
searchReferral(curam.commonintake.facade.struct.ReferralCaseSearchCriteria details)
Searches for an referral case based on the specified search criteria.
|
void |
setApplicationReadyForDetermination(curam.commonintake.facade.struct.ApplicationCaseAndVersionNoKey key)
Updates the application case status to 'Ready For Determination'.
|
void |
storeMyProgramsDueFilterCriteria(curam.commonintake.facade.struct.MyProgramsDueFilterCriteria filterCriteria)
Persists the filter criteria for the 'My Programs Due' search.
|
curam.core.facade.pdt.struct.InformationalMessageList |
validateEvidence(curam.commonintake.facade.struct.ApplicationCaseKey key)
Validates the evidence associated with the application case.
|
curam.commonintake.facade.struct.ApplicationCaseHomeDetails |
viewApplicationHomeDetails(curam.commonintake.entity.struct.ApplicationCaseKey key)
Retrieves the application details to be displayed on the home tab of the
application case.
|
curam.commonintake.facade.struct.ApplicationCaseDetailsList listApplicationCaseByOwner() throws curam.util.exception.AppException, curam.util.exception.InformationalException
curam.util.exception.AppException
- Generic Exception.curam.util.exception.InformationalException
- Generic Exception.curam.commonintake.facade.struct.ApplicationCaseContextPanelDetails readContextPanelDetails(curam.core.struct.CaseHeaderKey key) throws curam.util.exception.AppException, curam.util.exception.InformationalException
key
- The unique identifier for the application case.curam.util.exception.AppException
- Generic Exception.curam.util.exception.InformationalException
- Generic Exception.curam.commonintake.facade.struct.ApplicationCaseReadDetailsForCreate readDetailsForCreate() throws curam.util.exception.AppException, curam.util.exception.InformationalException
curam.util.exception.AppException
- Generic Exception.curam.util.exception.InformationalException
- Generic Exception.curam.commonintake.entity.struct.ApplicationCaseKey createApplicationCaseForConcernRole(curam.commonintake.facade.struct.ApplicationCaseCreateDetails details) throws curam.util.exception.AppException, curam.util.exception.InformationalException
details
- The details required to create the application case.curam.util.exception.AppException
- Generic Exception.curam.util.exception.InformationalException
- Generic Exception.curam.commonintake.facade.struct.ApplicationClientDetailsList listClients(curam.commonintake.entity.struct.ApplicationCaseKey key) throws curam.util.exception.AppException, curam.util.exception.InformationalException
key
- An application case entity key.curam.util.exception.AppException
- Generic Exception.curam.util.exception.InformationalException
- Generic Exception.curam.commonintake.facade.struct.FindClientList searchOrAddClient(curam.commonintake.facade.struct.FindClientKey key) throws curam.util.exception.AppException, curam.util.exception.InformationalException
key
- The details required to search for a client or add a client to
the application case.curam.util.exception.AppException
- Generic Exception.curam.util.exception.InformationalException
- Generic Exception.void registerClient(curam.commonintake.facade.struct.RegisterClientDetails dtls) throws curam.util.exception.AppException, curam.util.exception.InformationalException
dtls
- The details required to register the client.curam.util.exception.AppException
- Generic Exception.curam.util.exception.InformationalException
- Generic Exception.curam.commonintake.facade.struct.ApplicationClientDetailsList listPotentialMatches(curam.commonintake.facade.struct.ApplicationCaseAndConcernRoleKey key) throws curam.util.exception.AppException, curam.util.exception.InformationalException
key
- The client and application case unique identifiers.curam.util.exception.AppException
- Generic Exception.curam.util.exception.InformationalException
- Generic Exception.curam.commonintake.facade.struct.ProgramDetailsList listPrograms(curam.commonintake.entity.struct.ApplicationCaseKey key) throws curam.util.exception.AppException, curam.util.exception.InformationalException
key
- The unique identifier of the application case for which the
program details are being sought.curam.util.exception.AppException
- Generic Exception.curam.util.exception.InformationalException
- Generic Exception.curam.commonintake.facade.struct.ApplicationCaseDetailsList listApplicationCaseByConcernRole(curam.core.struct.ConcernRoleKey key) throws curam.util.exception.AppException, curam.util.exception.InformationalException
key
- The unique identifier of the participant for which the
application cases are being sought.curam.util.exception.AppException
- Generic Exception.curam.util.exception.InformationalException
- Generic Exception.curam.commonintake.facade.struct.ApplicationCaseHomeDetails viewApplicationHomeDetails(curam.commonintake.entity.struct.ApplicationCaseKey key) throws curam.util.exception.AppException, curam.util.exception.InformationalException
key
- The unique identifier of tha application case.curam.util.exception.AppException
- Generic Exception.curam.util.exception.InformationalException
- Generic Exception.curam.commonintake.facade.struct.ApplicationRelatedCaseList listClientCases(curam.commonintake.entity.struct.ApplicationCaseKey key) throws curam.util.exception.AppException, curam.util.exception.InformationalException
key
- The unique identifier of tha application case.curam.util.exception.AppException
- Generic Exception.curam.util.exception.InformationalException
- Generic Exception.curam.commonintake.facade.struct.ApplicationCaseReadDetails readApplicationDetails(curam.commonintake.entity.struct.ApplicationCaseKey key) throws curam.util.exception.AppException, curam.util.exception.InformationalException
key
- The unique identifier of the application case.curam.util.exception.AppException
- Generic Exception.curam.util.exception.InformationalException
- Generic Exception.void modifyApplicationDetails(curam.commonintake.facade.struct.ApplicationCaseReadDetails details) throws curam.util.exception.AppException, curam.util.exception.InformationalException
details
- The application case details to be modified.curam.util.exception.AppException
- Generic Exception.curam.util.exception.InformationalException
- Generic Exception.void setApplicationReadyForDetermination(curam.commonintake.facade.struct.ApplicationCaseAndVersionNoKey key) throws curam.util.exception.AppException, curam.util.exception.InformationalException
key
- The unique identifier of tha application case.curam.util.exception.AppException
- Generic Exception.curam.util.exception.InformationalException
- Generic Exception.void addProgram(curam.commonintake.facade.struct.ApplicationCaseProgramDetails details) throws curam.util.exception.AppException, curam.util.exception.InformationalException
details
- The program details.curam.util.exception.AppException
- Generic Exception.curam.util.exception.InformationalException
- Generic Exception.curam.commonintake.facade.struct.ProgramTypeDetailsList listProgramsConfiguredForApplication(curam.commonintake.entity.struct.ApplicationCaseKey key) throws curam.util.exception.AppException, curam.util.exception.InformationalException
key
- The unique identifier of tha application case.curam.util.exception.AppException
- Generic Exception.curam.util.exception.InformationalException
- Generic Exception.void modifyProgramDateAdded(curam.commonintake.facade.struct.ApplicationCaseProgramDetails details) throws curam.util.exception.AppException, curam.util.exception.InformationalException
details
- The program details.curam.util.exception.AppException
- Generic Exception.curam.util.exception.InformationalException
- Generic Exception.curam.commonintake.facade.struct.ApplicationCaseProgramDateAddedDetails readProgramDateAddedDetails(curam.workspaceservices.intake.struct.IntakeProgramApplicationKey key) throws curam.util.exception.AppException, curam.util.exception.InformationalException
key
- The unique identifier of the program.curam.util.exception.AppException
- Generic Exception.curam.util.exception.InformationalException
- Generic Exception.curam.commonintake.facade.struct.MyApplicationsList search(curam.commonintake.facade.struct.ApplicationCaseSearchCriteria details) throws curam.util.exception.AppException, curam.util.exception.InformationalException
details
- The search criteria details.curam.util.exception.AppException
- Generic Exception.curam.util.exception.InformationalException
- Generic Exception.curam.commonintake.facade.struct.ApplicationCaseSearchCriteriaDisplayDetails getSearchCriteria() throws curam.util.exception.AppException, curam.util.exception.InformationalException
curam.util.exception.AppException
- Generic Exception.curam.util.exception.InformationalException
- Generic Exception.curam.commonintake.facade.struct.MyApplicationsList listMyApplications() throws curam.util.exception.AppException, curam.util.exception.InformationalException
Retrieves a list of all application cases assigned to the currently logged in user that meet the following criteria.
curam.util.exception.AppException
- Generic Exception.curam.util.exception.InformationalException
- Generic Exception.void removeClient(curam.commonintake.facade.struct.CaseParticipantRoleAndVersionNo key) throws curam.util.exception.AppException, curam.util.exception.InformationalException
key
- The case participant role identifier and version number.curam.util.exception.AppException
- Generic Exception.curam.util.exception.InformationalException
- Generic Exception.curam.commonintake.facade.struct.ApplicationClientDetailsList listPreviousClients(curam.commonintake.entity.struct.ApplicationCaseKey key) throws curam.util.exception.AppException, curam.util.exception.InformationalException
key
- The unique identifier of the application case.curam.util.exception.AppException
- Generic Exception.curam.util.exception.InformationalException
- Generic Exception.curam.commonintake.facade.struct.FindClientList searchOrMatchClient(curam.commonintake.facade.struct.FindClientKey key) throws curam.util.exception.AppException, curam.util.exception.InformationalException
key
- The details required to search for a client or match a client.curam.util.exception.AppException
- Generic Exception.curam.util.exception.InformationalException
- Generic Exception.curam.core.facade.struct.ListEventDetails1 listMeetings(curam.core.facade.struct.ListEventKey key) throws curam.util.exception.AppException, curam.util.exception.InformationalException
key
- The unique identifier of the application case.curam.util.exception.AppException
- Generic Exception.curam.util.exception.InformationalException
- Generic Exception.void registerProspectPerson(curam.commonintake.facade.struct.RegisterClientDetails dtls) throws curam.util.exception.AppException, curam.util.exception.InformationalException
dtls
- The details required to register the prospect person.curam.util.exception.AppException
- Generic Exception.curam.util.exception.InformationalException
- Generic Exception.curam.commonintake.facade.struct.RegisterClientDetails readProspectPersonDetails(curam.commonintake.facade.struct.ProspectConcernRoleID Key) throws curam.util.exception.AppException, curam.util.exception.InformationalException
Key
- The concern role of the prospect person.curam.util.exception.AppException
- Generic Exception.curam.util.exception.InformationalException
- Generic Exception.curam.commonintake.facade.struct.ApplicationCaseHomepageURI getHomepage(curam.commonintake.facade.struct.ApplicationCaseKey key) throws curam.util.exception.AppException, curam.util.exception.InformationalException
key
- The unique identifier of the application case.curam.util.exception.AppException
- Generic Exception.curam.util.exception.InformationalException
- Generic Exception.void assignToCurrentUser(curam.commonintake.facade.struct.ApplicationCaseKey key) throws curam.util.exception.AppException, curam.util.exception.InformationalException
key
- The unique identifier of the application case.curam.util.exception.AppException
- Generic Exception.curam.util.exception.InformationalException
- Generic Exception.curam.commonintake.facade.struct.MyProgramsDueList listMyProgramsDue() throws curam.util.exception.AppException, curam.util.exception.InformationalException
curam.util.exception.AppException
- Generic Exception.curam.util.exception.InformationalException
- Generic Exception.void storeMyProgramsDueFilterCriteria(curam.commonintake.facade.struct.MyProgramsDueFilterCriteria filterCriteria) throws curam.util.exception.AppException, curam.util.exception.InformationalException
filterCriteria
- The 'My Programs Due' search filter criteria.curam.util.exception.AppException
- Generic Exception.curam.util.exception.InformationalException
- Generic Exception.curam.commonintake.facade.struct.MyProgramsDueFilterCriteria getMyProgramsDueFilterCriteria() throws curam.util.exception.AppException, curam.util.exception.InformationalException
curam.util.exception.AppException
- Generic Exception.curam.util.exception.InformationalException
- Generic Exception.curam.commonintake.facade.struct.ReferralApplicationCaseReadDetails readReferralApplicationDetails(curam.commonintake.entity.struct.ApplicationCaseKey key) throws curam.util.exception.AppException, curam.util.exception.InformationalException
key
- The unique identifier of the referral application case.curam.util.exception.AppException
- Generic Exception.curam.util.exception.InformationalException
- Generic Exception.curam.commonintake.entity.struct.ApplicationCaseKey createReferralApplicationCaseForConcernRole(curam.commonintake.facade.struct.ApplicationCaseCreateDetails details) throws curam.util.exception.AppException, curam.util.exception.InformationalException
details
- The details required to create the referral application
case.curam.util.exception.AppException
- Generic Exception.curam.util.exception.InformationalException
- Generic Exception.curam.commonintake.facade.struct.ApplicationCaseReadDetailsForCreate readReferralCreateDetails() throws curam.util.exception.AppException, curam.util.exception.InformationalException
curam.util.exception.AppException
- Generic Exception.curam.util.exception.InformationalException
- Generic Exception.curam.commonintake.facade.struct.ApplicationCaseDetailsList listReferralCaseByConcernRole(curam.core.struct.ConcernRoleKey key) throws curam.util.exception.AppException, curam.util.exception.InformationalException
key
- The unique identifier of the participant for which the
application cases are being sought.curam.util.exception.AppException
- Generic Exception.curam.util.exception.InformationalException
- Generic Exception.curam.commonintake.facade.struct.ApplicationCaseSearchCriteriaDisplayDetails getReferralSearchCriteria() throws curam.util.exception.AppException, curam.util.exception.InformationalException
curam.util.exception.AppException
- Generic Exception.curam.util.exception.InformationalException
- Generic Exception.curam.commonintake.facade.struct.MyApplicationsList searchReferral(curam.commonintake.facade.struct.ReferralCaseSearchCriteria details) throws curam.util.exception.AppException, curam.util.exception.InformationalException
details
- The search criteria details.curam.util.exception.AppException
- Generic Exception.curam.util.exception.InformationalException
- Generic Exception.curam.commonintake.facade.struct.MyApplicationsList listMyReferrals() throws curam.util.exception.AppException, curam.util.exception.InformationalException
Retrieves a list of all referrral application cases assigned to the currently logged in user that meet the following criteria.
curam.util.exception.AppException
- Generic Exception.curam.util.exception.InformationalException
- Generic Exception.curam.commonintake.facade.struct.ReferralCaseDetails readCaseDetails(curam.commonintake.entity.struct.ApplicationCaseKey arg1) throws curam.util.exception.AppException, curam.util.exception.InformationalException
key
- The unique identifier of the referral application case.curam.util.exception.AppException
- Generic Exception.curam.util.exception.InformationalException
- Generic Exception.void resubmitApplication(curam.commonintake.facade.struct.ApplicationCaseKey key) throws curam.util.exception.AppException, curam.util.exception.InformationalException
curam.util.exception.AppException
curam.util.exception.InformationalException
curam.core.facade.pdt.struct.InformationalMessageList validateEvidence(curam.commonintake.facade.struct.ApplicationCaseKey key) throws curam.util.exception.AppException, curam.util.exception.InformationalException
curam.util.exception.AppException
curam.util.exception.InformationalException
curam.commonintake.facade.struct.ApplicationCaseMessages checkAnyPendingCases(curam.commonintake.facade.struct.ApplicationCaseKey key) throws curam.util.exception.AppException, curam.util.exception.InformationalException
key
- The unique identifier of the application case.curam.util.exception.AppException
- Generic Exception.curam.util.exception.InformationalException
- Generic Exception.curam.commonintake.facade.struct.ApplicationCaseMessages checkAnyPendingCasesByProgram(curam.commonintake.facade.struct.ApplicationCaseKey appCaseKey, curam.commonintake.facade.struct.IntakeProgramKey programKey) throws curam.util.exception.AppException, curam.util.exception.InformationalException
key
- The unique identifier of the application case.key
- The unique identifier of the intake program application case.curam.util.exception.AppException
- Generic Exception.curam.util.exception.InformationalException
- Generic Exception.