curam.isproduct.intakeapplication.facade.intf

Interface IntakeInformation

All Known Implementing Classes:

IntakeInformation, curam.isproduct.intakeapplication.facade.impl.IntakeInformation, IntakeInformationFactory

@AccessLevel(value=EXTERNAL)
public interface IntakeInformation

This business interface provides operations related to the intake processing.

Method Summary

Modifier and Type	Method and Description
curam.isproduct.intakeapplication.sl.struct.ReturnIntakeInformation	create(curam.isproduct.intakeapplication.sl.entity.struct.IntakeInformationDetails dtls) Creates an intake application.
curam.core.struct.InformationalMsgDtlsList	createInformationalMessages(curam.workspaceservices.intake.struct.IntakeApplicationKey key) Creates a list of informational messages.
curam.isproduct.intakeapplication.sl.struct.ReturnIntakeInformation	createIntakeFromScreening(curam.isproduct.intakeapplication.sl.entity.struct.IntakeInformationDetails dtls, curam.core.struct.IntegratedCaseKey key) Creates an intake application and links it with a specified integrated case.
curam.isproduct.intakeapplication.sl.struct.ReturnIntakeInformation	createWithIntegratedCase(curam.isproduct.intakeapplication.sl.entity.struct.IntakeInformationDetails dtls, curam.core.struct.IntegratedCaseKey integratedCaseKey) Creates an intake application and links it with an existing case.
curam.core.struct.CaseID	getCaseIDFromIntakeApplicationID(curam.workspaceservices.intake.struct.IntakeApplicationKey intakeApplicationKey) Reads the identifier of a case for an intake application.
curam.isproduct.intakeapplication.sl.struct.ProgramTypeList	getProgramTypes() Reads a list of program types that may be applied for.
curam.isproduct.facade.struct.MappingEnvironmentDetails	isMappingRequired()
curam.isproduct.intakeapplication.sl.struct.ReturnIntakeInformation	modify(curam.isproduct.intakeapplication.sl.entity.struct.IntakeInformationDetails dtls) Modifies the details of an intake application.
curam.isproduct.intakeapplication.sl.entity.struct.IntakeInformationDetails	read(curam.isproduct.intakeapplication.sl.entity.struct.IntakeInformationKey key) Reads the details of an intake application.
curam.core.struct.AttachmentDtls	readAttachment(curam.core.struct.AttachmentKey attachmentKey) Reads the details of an attachment.
curam.isproduct.intakeapplication.sl.entity.struct.IntakeInformationDetails	readByIntakeApplicationID(curam.workspaceservices.intake.struct.IntakeApplicationKey key) Reads the details of an intake information record for an intake application.
curam.isproduct.intakeapplication.sl.entity.struct.EmergencyExpeditedFlags	readEmergencyExpeditedFlags(curam.workspaceservices.intake.struct.IntakeApplicationKey key) Reads the expedited and emergency flags from the intake information.

Method Detail

create

@AccessLevel(value=EXTERNAL)
curam.isproduct.intakeapplication.sl.struct.ReturnIntakeInformation create(curam.isproduct.intakeapplication.sl.entity.struct.IntakeInformationDetails dtls)
                                                                                                 throws curam.util.exception.AppException,
                                                                                                        curam.util.exception.InformationalException

Creates an intake application.

Parameters:

dtls - The details of the intake information record.

Returns:

Identifier of the intake application.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

Attachment, IntakeApplication, IntakeAvailTimesForInterview, IntakeInformation, IntakeProgramApplication

read

@AccessLevel(value=EXTERNAL)
curam.isproduct.intakeapplication.sl.entity.struct.IntakeInformationDetails read(curam.isproduct.intakeapplication.sl.entity.struct.IntakeInformationKey key)
                                                                                                       throws curam.util.exception.AppException,
                                                                                                              curam.util.exception.InformationalException

Reads the details of an intake application.

Parameters:

key - Identifier of the intake information record.

Returns:

Identifier of the intake application.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Attachment, IntakeApplication, IntakeAvailTimesForInterview, IntakeInformation, IntakeProgramApplication

modify

@AccessLevel(value=EXTERNAL)
curam.isproduct.intakeapplication.sl.struct.ReturnIntakeInformation modify(curam.isproduct.intakeapplication.sl.entity.struct.IntakeInformationDetails dtls)
                                                                                                 throws curam.util.exception.AppException,
                                                                                                        curam.util.exception.InformationalException

Modifies the details of an intake application.

Parameters:

dtls - The details of an intake application. The details will include interview details, intake information, attachment details and intake application details.

Returns:

Identifier of the intake application.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Attachment, IntakeAvailTimesForInterview, ProgramType

Business Object Write:

Attachment, IntakeApplication, IntakeAvailTimesForInterview, IntakeInformation, IntakeProgramApplication

readByIntakeApplicationID

@AccessLevel(value=EXTERNAL)
curam.isproduct.intakeapplication.sl.entity.struct.IntakeInformationDetails readByIntakeApplicationID(curam.workspaceservices.intake.struct.IntakeApplicationKey key)
                                                                                                                            throws curam.util.exception.AppException,
                                                                                                                                   curam.util.exception.InformationalException

Reads the details of an intake information record for an intake application.

Parameters:

key - Identifier of the intake application.

Returns:

Details of an intake information record.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

IntakeInformation

getProgramTypes

@AccessLevel(value=EXTERNAL)
curam.isproduct.intakeapplication.sl.struct.ProgramTypeList getProgramTypes()
                                                                                                  throws curam.util.exception.AppException,
                                                                                                         curam.util.exception.InformationalException

Reads a list of program types that may be applied for.

Returns:

A list of program types.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

ApplicationTypeProgramLink, IntakeApplicationType, ProgramType

readEmergencyExpeditedFlags

@AccessLevel(value=EXTERNAL)
curam.isproduct.intakeapplication.sl.entity.struct.EmergencyExpeditedFlags readEmergencyExpeditedFlags(curam.workspaceservices.intake.struct.IntakeApplicationKey key)
                                                                                                                             throws curam.util.exception.AppException,
                                                                                                                                    curam.util.exception.InformationalException

Reads the expedited and emergency flags from the intake information.
These flags indicate the potential eligibility for expedited and emergency food assistance.

Parameters:

key - Identifier of the intake application.

Returns:

The expedited and emergency flags from the intake information.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

IntakeInformation

createWithIntegratedCase

@AccessLevel(value=EXTERNAL)
curam.isproduct.intakeapplication.sl.struct.ReturnIntakeInformation createWithIntegratedCase(curam.isproduct.intakeapplication.sl.entity.struct.IntakeInformationDetails dtls,
                                                                                                                          curam.core.struct.IntegratedCaseKey integratedCaseKey)
                                                                                                                   throws curam.util.exception.AppException,
                                                                                                                          curam.util.exception.InformationalException

Creates an intake application and links it with an existing case.

Parameters:

dtls - The details of the intake application.

integratedCaseKey - Identifier of the integrated case.

Returns:

Identifier of the intake application.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

IntakeApplication, IntakeProgramApplication

createInformationalMessages

@AccessLevel(value=EXTERNAL)
curam.core.struct.InformationalMsgDtlsList createInformationalMessages(curam.workspaceservices.intake.struct.IntakeApplicationKey key)
                                                                                             throws curam.util.exception.AppException,
                                                                                                    curam.util.exception.InformationalException

Creates a list of informational messages.

Parameters:

key - Identifier of the intake application.

Returns:

The list of informational messages.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

IntakeApplication

readAttachment

@AccessLevel(value=EXTERNAL)
curam.core.struct.AttachmentDtls readAttachment(curam.core.struct.AttachmentKey attachmentKey)
                                                                      throws curam.util.exception.AppException,
                                                                             curam.util.exception.InformationalException

Reads the details of an attachment.

Parameters:

attachmentKey - Identifier of the attachement.

Returns:

The details of an attachment.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Attachment

getCaseIDFromIntakeApplicationID

@AccessLevel(value=EXTERNAL)
curam.core.struct.CaseID getCaseIDFromIntakeApplicationID(curam.workspaceservices.intake.struct.IntakeApplicationKey intakeApplicationKey)
                                                                                throws curam.util.exception.AppException,
                                                                                       curam.util.exception.InformationalException

Reads the identifier of a case for an intake application.

Parameters:

intakeApplicationKey - Identifier of an intake application.

Returns:

Identifier of the case for the specified intake application.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

CaseHeader

createIntakeFromScreening

@AccessLevel(value=EXTERNAL)
curam.isproduct.intakeapplication.sl.struct.ReturnIntakeInformation createIntakeFromScreening(curam.isproduct.intakeapplication.sl.entity.struct.IntakeInformationDetails dtls,
                                                                                                                           curam.core.struct.IntegratedCaseKey key)
                                                                                                                    throws curam.util.exception.AppException,
                                                                                                                           curam.util.exception.InformationalException

Creates an intake application and links it with a specified integrated case.

Parameters:

dtls - Details of an intake application.

integratedCaseKey - Identifier of the integrated case.

Returns:

Identifier of the intake application.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Applicant, CaseStatus, ConcernRole, CaseParticipantRole, ConcernRoleRelationship, IntakeProgramApplication, IntakeApplication, Users

Business Object Write:

Applicant

isMappingRequired

curam.isproduct.facade.struct.MappingEnvironmentDetails isMappingRequired()
                                                                   throws curam.util.exception.AppException,
                                                                          curam.util.exception.InformationalException

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException