@AccessLevel(value=EXTERNAL)
public interface ApplicationCase
extends curam.piwrapper.caseheader.impl.CaseHeader, curam.util.persistence.helper.Lifecycle<curam.commonintake.codetable.impl.APPLICATIONCASESTATUSEntry>, curam.util.persistence.OptimisticLockModifiable
ApplicationCase
is used to process an application for a program.Modifier and Type | Method and Description |
---|---|
void |
addClientToApplication(curam.participant.impl.ConcernRole concernRole)
Adds a client to the
ApplicationCase . |
void |
changeStatusForResubmit()
Changes
ApplicationCase status to
APPLICATIONCASESTATUSEntry.CREATED . |
void |
close(curam.commonintake.codetable.impl.APPCASECLOSUREREASONEntry closureReason,
java.lang.String closureComments,
int versionNo)
Closes the
ApplicationCase , setting the status to
APPLICATIONCASESTATUSEntry.CLOSED . |
void |
completeResolution()
Changes
ApplicationCase status to
APPLICATIONCASESTATUSEntry.OPEN . |
void |
createCaseForIntake(java.util.List<curam.participant.impl.ConcernRole> clients,
boolean onlineInd)
Creates an application case in
APPLICATIONCASESTATUSEntry.OPEN
status for the specified list of clients. |
curam.commonintake.codetable.impl.APPLICATIONCASESTATUSEntry |
determineApplicationCaseStatus()
Determines the status of the
ApplicationCase based on the status of
the list of IntakeProgramApplication . |
java.util.List<curam.workspaceservices.codetable.impl.IntakeProgramApplicationStatusEntry> |
fetchProgramStatus()
Fetches the unique list of IntakeProgram application status entries.
|
ApplicationCaseAdmin |
getApplicationCaseAdmin()
Gets the administration configuration details for the
ApplicationCase . |
curam.util.type.Date |
getApplicationDate()
Returns the date on which the application was received by the organization.
|
java.lang.String |
getApplicationReference()
Returns the application reference.
|
java.lang.String |
getComments() |
curam.piwrapper.user.impl.User |
getCreatedBy()
Retrieves the user who created the application case.
|
boolean |
getInterpreterInd()
Returns the interpreter indicator which indicates if an interpreter is
required for the interview.
|
curam.codetable.impl.LANGUAGEEntry |
getInterpreterLanguage()
Returns the interpreter language required for the interview.
|
curam.commonintake.codetable.impl.METHODOFAPPLICATIONEntry |
getMethodOfApplication()
Returns the method of of application.
|
curam.commonintake.codetable.impl.CIPREFERREDCONTACTEntry |
getPreferredContact()
Returns the preferred contact method for the clients on the application.
|
java.util.List<curam.workspaceservices.intake.impl.IntakeProgramApplication> |
getPrograms()
Retrieves a list of programs associated to the
ApplicationCase . |
curam.commonintake.codetable.impl.CIRREFERRALREASONEntry |
getReferralReason()
Returns the reason for initiating the referral.
|
curam.commonintake.codetable.impl.REFERRALSOURCEEntry |
getReferralSource()
Returns the source of the referral.
|
java.lang.String |
getReferralSourceDescription()
Returns the additional information captured about the referral source.
|
java.lang.String |
getReferredBy()
Retrieves the name of the person who referred the client.
|
java.lang.String |
getSpecialAssistance()
Return the Special Assistance details.
|
boolean |
getSpecialAssistanceInd()
Returns the Special Assistance indicator which indicates whether the
client(s) require special assistance for the interview.
|
curam.util.type.DateTime |
getSubmittedDateTime()
Returns the date on which the application was submitted.
|
void |
initiateResolution()
Changes
ApplicationCase status to
APPLICATIONCASESTATUSEntry.AWAITINGRESOLUTION and change the
ownership to issue owner which is configured in Application Case Admin. |
void |
insert(java.util.List<curam.participant.impl.ConcernRole> clients,
boolean onlineInd)
Creates an application case for the specified list of clients.
|
void |
matchClient(curam.participant.impl.ConcernRole origionalConcernRole,
curam.participant.prospect.impl.ProspectPerson duplicateConcernRole)
Matches a prospect person to a registered person on the
ApplicationCase . |
void |
readyForDetermination(int versionNo)
Moves the application case to the
APPLICATIONCASESTATUSEntry.READYFORDETERMINATION state. |
void |
removeClient(curam.piwrapper.casemanager.impl.CaseParticipantRole caseParticipantRole,
int versionNo)
Removes a client from the
ApplicationCase by cancelling the
CaseParticipantRole . |
void |
reopen(curam.commonintake.codetable.impl.APPCASEREOPENREASONEntry reopenReason,
java.lang.String reopenComments,
int versionNo)
Reopens the
ApplicationCase , setting the status to
APPLICATIONCASESTATUSEntry.OPEN . |
void |
resetApplicationCaseStatus()
Resets the status of the
ApplicationCase based on the status of the
list of IntakeProgramApplication . |
void |
setApplicationCaseAdmin(ApplicationCaseAdmin applicationCaseAdmin)
Sets the application case configuration used.
|
void |
setApplicationDate(curam.util.type.Date applicationDate)
Sets the application date.
|
void |
setApplicationReference(java.lang.String reference)
Sets the application reference.
|
void |
setApplicationToAuthorisationFailed()
Changes
ApplicationCase status to
APPLICATIONCASESTATUSEntry.AUTHORIZATIONFAILED . |
void |
setApplicationToAuthorisationInProgress()
Changes
ApplicationCase status to
APPLICATIONCASESTATUSEntry.AUTHORIZATIONINPROGRESS . |
void |
setComments(java.lang.String comments)
Sets the comments.
|
void |
setInterpreterInd(boolean interpreterInd)
Sets the interpreter indicator.
|
void |
setInterpreterLanguage(curam.codetable.impl.LANGUAGEEntry language)
Sets the interpreter language required for the interview.
|
void |
setMethodOfApplication(curam.commonintake.codetable.impl.METHODOFAPPLICATIONEntry methodOfApplication)
Sets the method of of application.
|
void |
setPreferredContact(curam.commonintake.codetable.impl.CIPREFERREDCONTACTEntry preferredContact)
Sets the preferred contact method.
|
void |
setReferralReason(curam.commonintake.codetable.impl.CIRREFERRALREASONEntry referralReason)
Sets the reason for initiating the referral.
|
void |
setReferralSource(curam.commonintake.codetable.impl.REFERRALSOURCEEntry referralSource)
Sets the source of the referral.
|
void |
setReferralSourceDescription(java.lang.String description)
Sets the additional information captured about the referral source.
|
void |
setReferredBy(java.lang.String referredBy)
Sets the name of the person who referred the client.
|
void |
setSpecialAssistance(java.lang.String specialAssistance)
Sets the Special Assistance details.
|
void |
setSpecialAssistanceInd(boolean specialAssistanceInd)
Sets the Special Assistance indicator.
|
void |
setSubmittedDateTime(curam.util.type.DateTime submittedDateTime)
Sets the submitted date time.
|
checkSecurity, getActualOutcome, getAdminCaseConfiguration, getAdminConfigurationID, getCaseHeaderVersionNo, getCaseReference, getCaseType, getClassification, getConcernRole, getDefaultCurrency, getDefaultDeliveryMethod, getDescription, getEffectiveDate, getEndDate, getExpectedEndDate, getExpectedOutcome, getExpectedStartDate, getFirstReviewDate, getHomePageName, getIntegratedCaseType, getName, getObjective, getOutcome, getOwnerOrgObjectLink, getParentCase, getPriority, getReceivedDate, getRegistrationDate, getServicePlanDelivery, getStartDate, getStatus, hasAppeal, listActiveCaseMembers, listActiveCaseParticipantRoles, listSupervisorsForCaseOwner, readSupervisor, readSupervisorForCaseOwner
ApplicationCaseAdmin getApplicationCaseAdmin()
ApplicationCase
.ApplicationCase
configuration details.setApplicationCaseAdmin(ApplicationCaseAdmin)
curam.util.type.DateTime getSubmittedDateTime()
setSubmittedDateTime(DateTime)
curam.util.type.Date getApplicationDate()
setApplicationDate(Date)
java.lang.String getApplicationReference()
setApplicationReference(String)
curam.piwrapper.user.impl.User getCreatedBy()
curam.commonintake.codetable.impl.METHODOFAPPLICATIONEntry getMethodOfApplication()
setMethodOfApplication(METHODOFAPPLICATIONEntry)
void setApplicationCaseAdmin(ApplicationCaseAdmin applicationCaseAdmin)
applicationCaseAdmin
- The application case configuration to be usedgetApplicationCaseAdmin()
void setSubmittedDateTime(curam.util.type.DateTime submittedDateTime)
submittedDateTime
- The date and time the application was submitted.getSubmittedDateTime()
void setApplicationDate(curam.util.type.Date applicationDate)
applicationDate
- The application date time.getApplicationDate()
void setApplicationReference(java.lang.String reference)
reference
- The reference for the applicationgetApplicationReference()
void setInterpreterInd(boolean interpreterInd)
interpreterInd
- This will be set to true if an interpreter is required, false
otherwisegetInterpreterInd()
void setSpecialAssistanceInd(boolean specialAssistanceInd)
specialAssistanceInd
- This will be set to true if an interpreter is required, false
otherwisegetSpecialAssistanceInd()
void setSpecialAssistance(java.lang.String specialAssistance)
specialAssistance
- the special requirements for the client.getSpecialAssistance()
void setInterpreterLanguage(curam.codetable.impl.LANGUAGEEntry language)
language
- The language required for the interview.getInterpreterLanguage()
boolean getInterpreterInd()
setInterpreterInd(boolean)
boolean getSpecialAssistanceInd()
setSpecialAssistanceInd(boolean)
java.lang.String getSpecialAssistance()
setSpecialAssistance(String)
curam.codetable.impl.LANGUAGEEntry getInterpreterLanguage()
setInterpreterLanguage(LANGUAGEEntry)
void setMethodOfApplication(curam.commonintake.codetable.impl.METHODOFAPPLICATIONEntry methodOfApplication)
methodOfApplication
- The method of applicationgetMethodOfApplication()
void setPreferredContact(curam.commonintake.codetable.impl.CIPREFERREDCONTACTEntry preferredContact)
preferredContact
- The preferred contact method.getPreferredContact()
curam.commonintake.codetable.impl.CIPREFERREDCONTACTEntry getPreferredContact()
setPreferredContact(CIPREFERREDCONTACTEntry)
curam.commonintake.codetable.impl.REFERRALSOURCEEntry getReferralSource()
setReferralSource(REFERRALSOURCEEntry)
java.lang.String getReferralSourceDescription()
#setReferralDescription(String)
curam.commonintake.codetable.impl.CIRREFERRALREASONEntry getReferralReason()
#setReferralReason(REFERRALREASONEntry)
java.lang.String getReferredBy()
setReferredBy(String)
java.lang.String getComments()
getComments
in interface curam.piwrapper.caseheader.impl.CaseHeader
void setReferralSource(curam.commonintake.codetable.impl.REFERRALSOURCEEntry referralSource)
referralSource
- the source of referral.getReferralSource()
void setReferralSourceDescription(java.lang.String description)
description
- the referral source description.getReferralSourceDescription()
void setReferralReason(curam.commonintake.codetable.impl.CIRREFERRALREASONEntry referralReason)
referralReason
- the referral reason.getReferralReason()
void setReferredBy(java.lang.String referredBy)
referredBy
- the name of the person who referred the client.getReferredBy()
void setComments(java.lang.String comments)
comments
- the comments captured for referral.getComments()
void insert(java.util.List<curam.participant.impl.ConcernRole> clients, boolean onlineInd) throws curam.util.exception.AppException, curam.util.exception.InformationalException
The following exception messages are thrown by this operation:
APPLICATIONCASE#ERR_FV_CLIENT_MUST_BE_SELECTED
- if the clients
list is empty.APPLICATIONCASE#ERR_FV_APPLICATION_CASE_ADMIN_MANDATORY
- if the
application case configuration has not been set.clients
- The list of clients to add to the ApplicationCase
onlineInd
- Indicates if this ApplicationCase
was the result of an
online application. This is used to determine the case ownercuram.util.exception.AppException
- Generic Exception Signaturecuram.util.exception.InformationalException
- Generic Exception Signaturevoid addClientToApplication(curam.participant.impl.ConcernRole concernRole) throws curam.util.exception.InformationalException, curam.util.exception.AppException
ApplicationCase
. This also creates a link
between the client and the intake application record.concernRole
- The client to add to the ApplicationCase
curam.util.exception.InformationalException
- Generic Exception Signaturecuram.util.exception.AppException
- Generic Exception Signaturevoid removeClient(curam.piwrapper.casemanager.impl.CaseParticipantRole caseParticipantRole, int versionNo) throws curam.util.exception.AppException, curam.util.exception.InformationalException
ApplicationCase
by cancelling the
CaseParticipantRole
.caseParticipantRole
- The CaseParticipantRole
to cancelversionNo
- The version number of the CaseParticipantRole
curam.util.exception.AppException
- Generic Exception Signaturecuram.util.exception.InformationalException
- Generic Exception Signaturevoid readyForDetermination(int versionNo) throws curam.util.exception.InformationalException, curam.util.exception.AppException
APPLICATIONCASESTATUSEntry.READYFORDETERMINATION
state.versionNo
- The version number of the ApplicationCase
curam.util.exception.InformationalException
- Generic Exception Signaturecuram.util.exception.AppException
- Generic Exception Signaturevoid close(curam.commonintake.codetable.impl.APPCASECLOSUREREASONEntry closureReason, java.lang.String closureComments, int versionNo) throws curam.util.exception.InformationalException, curam.util.exception.AppException
ApplicationCase
, setting the status to
APPLICATIONCASESTATUSEntry.CLOSED
.closureReason
- The APPCASECLOSUREREASONEntry
for the closing the
ApplicationCase
.closureComments
- Comments relating to the closure of the ApplicationCase
.versionNo
- The version number of the ApplicationCase
curam.util.exception.InformationalException
- Generic Exception Signaturecuram.util.exception.AppException
- Generic Exception Signaturevoid reopen(curam.commonintake.codetable.impl.APPCASEREOPENREASONEntry reopenReason, java.lang.String reopenComments, int versionNo) throws curam.util.exception.InformationalException, curam.util.exception.AppException
ApplicationCase
, setting the status to
APPLICATIONCASESTATUSEntry.OPEN
.reopenReason
- The APPCASEREOPENREASONEntry
for reopening the
ApplicationCase
.reopenComments
- Comments relating to the reopening of the ApplicationCase
.versionNo
- The version number of the ApplicationCase
.curam.util.exception.InformationalException
- Generic Exception Signaturecuram.util.exception.AppException
- Generic Exception Signaturejava.util.List<curam.workspaceservices.intake.impl.IntakeProgramApplication> getPrograms()
ApplicationCase
.ApplicationCase
.void matchClient(curam.participant.impl.ConcernRole origionalConcernRole, curam.participant.prospect.impl.ProspectPerson duplicateConcernRole) throws curam.util.exception.InformationalException, curam.util.exception.AppException
ApplicationCase
.origionalConcernRole
- The registered clientduplicateConcernRole
- The prospect clientcuram.util.exception.InformationalException
- Generic Exception Signaturecuram.util.exception.AppException
- Generic Exception Signaturevoid initiateResolution() throws curam.util.exception.AppException, curam.util.exception.InformationalException
ApplicationCase
status to
APPLICATIONCASESTATUSEntry.AWAITINGRESOLUTION
and change the
ownership to issue owner which is configured in Application Case Admin.curam.util.exception.AppException
- Generic Exception Signaturecuram.util.exception.InformationalException
- Generic Exception Signaturevoid completeResolution() throws curam.util.exception.AppException, curam.util.exception.InformationalException
ApplicationCase
status to
APPLICATIONCASESTATUSEntry.OPEN
.curam.util.exception.AppException
- Generic Exception Signaturecuram.util.exception.InformationalException
- Generic Exception Signaturevoid changeStatusForResubmit() throws curam.util.exception.AppException, curam.util.exception.InformationalException
ApplicationCase
status to
APPLICATIONCASESTATUSEntry.CREATED
.curam.util.exception.AppException
- Generic Exception Signaturecuram.util.exception.InformationalException
- Generic Exception Signaturevoid createCaseForIntake(java.util.List<curam.participant.impl.ConcernRole> clients, boolean onlineInd) throws curam.util.exception.AppException, curam.util.exception.InformationalException
APPLICATIONCASESTATUSEntry.OPEN
status for the specified list of clients.
The following exception messages are thrown by this operation:
APPLICATIONCASE#ERR_FV_CLIENT_MUST_BE_SELECTED
- if the clients
list is empty.APPLICATIONCASE#ERR_FV_APPLICATION_CASE_ADMIN_MANDATORY
- if the
application case configuration has not been set.clients
- The list of clients to add to the ApplicationCase
onlineInd
- Indicates if this ApplicationCase
was the result of an
online application. This is used to determine the case ownercuram.util.exception.AppException
- Generic Exception Signaturecuram.util.exception.InformationalException
- Generic Exception Signaturevoid setApplicationToAuthorisationInProgress() throws curam.util.exception.AppException, curam.util.exception.InformationalException
ApplicationCase
status to
APPLICATIONCASESTATUSEntry.AUTHORIZATIONINPROGRESS
.curam.util.exception.AppException
- Generic Exception Signaturecuram.util.exception.InformationalException
- Generic Exception Signaturevoid setApplicationToAuthorisationFailed() throws curam.util.exception.AppException, curam.util.exception.InformationalException
ApplicationCase
status to
APPLICATIONCASESTATUSEntry.AUTHORIZATIONFAILED
.curam.util.exception.AppException
- Generic Exception Signaturecuram.util.exception.InformationalException
- Generic Exception Signaturecuram.commonintake.codetable.impl.APPLICATIONCASESTATUSEntry determineApplicationCaseStatus() throws curam.util.exception.AppException, curam.util.exception.InformationalException
ApplicationCase
based on the status of
the list of IntakeProgramApplication
.curam.util.exception.AppException
- Generic Exception Signaturecuram.util.exception.InformationalException
- Generic Exception Signaturejava.util.List<curam.workspaceservices.codetable.impl.IntakeProgramApplicationStatusEntry> fetchProgramStatus() throws curam.util.exception.AppException, curam.util.exception.InformationalException
IntakeProgramApplicationStatusEntry
of
the programs associated with application case.curam.util.exception.AppException
- Generic Exception Signaturecuram.util.exception.InformationalException
- Generic Exception Signaturevoid resetApplicationCaseStatus() throws curam.util.exception.AppException, curam.util.exception.InformationalException
ApplicationCase
based on the status of the
list of IntakeProgramApplication
.curam.util.exception.AppException
- Generic Exception Signaturecuram.util.exception.InformationalException
- Generic Exception Signature