@AccessLevel(value=EXTERNAL)
public interface ApplicationForm
Modifier and Type | Method and Description |
---|---|
void |
cancelApplicationForm(curam.commonintake.facade.struct.ApplicationFormVersionedKey key)
Cancels an application form setting the status to 'Cancelled'.
|
curam.commonintake.facade.struct.ApplicationFormIntakeScriptKey |
createApplicationForm(curam.commonintake.facade.struct.CreateApplicationFormKey key)
Creates an application form for an internal intake application of the
given type for the given programs.
|
curam.commonintake.facade.struct.FinishInternalIntakeScriptResult |
finishInternalIntakeScript(curam.commonintake.facade.struct.ApplicationFormIntakeScriptKey key)
Called when an internal intake IEG script finishes.
|
curam.commonintake.facade.struct.ApplicationFormDetailsList |
listApplicationFormsForConcernRole(curam.core.struct.ConcernRoleKey key)
Returns a list of application forms for the given concern role.
|
curam.commonintake.facade.struct.ApplicationFormIntakeApplications |
listInternalIntakeApplications()
Returns a list of all active internal Intake Application Types configured
on the system.
|
curam.commonintake.facade.struct.ApplicationFormIntakeApplications |
listInternalIntakeApplicationsByProgramType(curam.workspaceservices.intake.struct.ProgramTypeKey key)
Returns a list of all active internal Intake Application Types for the
given Program Type.
|
curam.commonintake.facade.struct.ApplicationFormDetailsList |
listMyInprogressApplicationsForm()
List the inprogress internal application form created by the logged in user
|
curam.commonintake.facade.struct.ApplicationFormPrograms |
listProgramsForIntakeApplication(curam.workspaceservices.intake.struct.IntakeApplicationTypeKey intakeApplicationTypeKey,
curam.workspaceservices.intake.struct.ProgramTypeKey programTypeKey,
curam.core.struct.ConcernRoleKey concernRoleKey)
Retrieve a list of Program Types that are linked to a given Intake
Application Type selected on the previous screen of the application form
coming from a Screening or Triage.
|
curam.commonintake.facade.struct.ApplicationFormIntakeScriptKey |
resumeApplicationForm(curam.commonintake.entity.struct.ApplicationFormKey key)
Resumes an application form that has previously been saved.
|
curam.workspaceservices.intake.struct.IntakeApplicationTypeKey |
selectInternalIntakeApplication(curam.workspaceservices.intake.struct.IntakeApplicationTypeKey key)
Passes information on the Internal Intake Application being applied for.
|
void |
submitApplicationForm(curam.commonintake.facade.struct.ApplicationFormVersionedKey key)
Submits an application form setting the status to 'Submitted' and also
submitting the internal intake application.
|
curam.commonintake.facade.struct.ApplicationFormIntakeScriptKey createApplicationForm(curam.commonintake.facade.struct.CreateApplicationFormKey key) throws curam.util.exception.AppException, curam.util.exception.InformationalException
key
- The type of intake application to be created along with the
programs being applied for, and the concern role ID of the client if
applicablecuram.util.exception.AppException
- Generic Exception.curam.util.exception.InformationalException
- Generic Exception.curam.commonintake.facade.struct.FinishInternalIntakeScriptResult finishInternalIntakeScript(curam.commonintake.facade.struct.ApplicationFormIntakeScriptKey key) throws curam.util.exception.AppException, curam.util.exception.InformationalException
key
- The execution ID of the intake application scriptcuram.util.exception.AppException
- Generic Exception.curam.util.exception.InformationalException
- Generic Exception.curam.workspaceservices.intake.struct.IntakeApplicationTypeKey selectInternalIntakeApplication(curam.workspaceservices.intake.struct.IntakeApplicationTypeKey key) throws curam.util.exception.AppException, curam.util.exception.InformationalException
key
- The type of intake application to be createdcuram.util.exception.AppException
- Generic Exception.curam.util.exception.InformationalException
- Generic Exception.curam.commonintake.facade.struct.ApplicationFormDetailsList listApplicationFormsForConcernRole(curam.core.struct.ConcernRoleKey key) throws curam.util.exception.AppException, curam.util.exception.InformationalException
key
- The unique identifier of the concern role to search bycuram.util.exception.AppException
- Generic Exception.curam.util.exception.InformationalException
- Generic Exception.void submitApplicationForm(curam.commonintake.facade.struct.ApplicationFormVersionedKey key) throws curam.util.exception.AppException, curam.util.exception.InformationalException
key
- The unique ID and version number of the application form to be
submittedcuram.util.exception.AppException
- Generic Exception.curam.util.exception.InformationalException
- Generic Exception.void cancelApplicationForm(curam.commonintake.facade.struct.ApplicationFormVersionedKey key) throws curam.util.exception.AppException, curam.util.exception.InformationalException
key
- The unique ID and version number of the application form to be
cancelled.curam.util.exception.AppException
- Generic Exception.curam.util.exception.InformationalException
- Generic Exception.curam.commonintake.facade.struct.ApplicationFormIntakeScriptKey resumeApplicationForm(curam.commonintake.entity.struct.ApplicationFormKey key) throws curam.util.exception.AppException, curam.util.exception.InformationalException
key
- The unique indentifier of the application form to be resumedcuram.util.exception.AppException
- Generic Exception.curam.util.exception.InformationalException
- Generic Exception.curam.commonintake.facade.struct.ApplicationFormIntakeApplications listInternalIntakeApplicationsByProgramType(curam.workspaceservices.intake.struct.ProgramTypeKey key) throws curam.util.exception.AppException, curam.util.exception.InformationalException
key
- The program type to filter bycuram.util.exception.AppException
- Generic Exception.curam.util.exception.InformationalException
- Generic Exception.curam.commonintake.facade.struct.ApplicationFormPrograms listProgramsForIntakeApplication(curam.workspaceservices.intake.struct.IntakeApplicationTypeKey intakeApplicationTypeKey, curam.workspaceservices.intake.struct.ProgramTypeKey programTypeKey, curam.core.struct.ConcernRoleKey concernRoleKey) throws curam.util.exception.AppException, curam.util.exception.InformationalException
concernRoleKey
- The concern role entity keyintakeApplicationTypeKey
- The intake application type to filter byprogramTypeKey
- The program from which the application form was
launchedcuram.util.exception.AppException
- Generic Exception.curam.util.exception.InformationalException
- Generic Exception.curam.commonintake.facade.struct.ApplicationFormIntakeApplications listInternalIntakeApplications() 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.ApplicationFormDetailsList listMyInprogressApplicationsForm() throws curam.util.exception.AppException, curam.util.exception.InformationalException
curam.util.exception.AppException
curam.util.exception.InformationalException