curam.application.facade.intf

Interface Application

All Known Implementing Classes:

Application, curam.application.facade.impl.Application, ApplicationFactory

public interface Application

This business interface provides operations related to applications. An application provides the means to collate and manage all the information required to process an individual's claim. It is central to the concept of an intake.

Method Summary

Modifier and Type	Method and Description
void	assignToMe(curam.application.facade.struct.ApplicationKey key) Assigns the application to the current user.
void	cancelApplication(curam.application.facade.struct.CancelApplication cancelApplication) Cancels an application.
void	cancelAttachment(curam.attachmentlink.struct.AttachmentLinkKey key) Cancels an application attachment.
void	cancelInterview(curam.application.facade.struct.CancelInterviewDetails details) Cancels an existing instance of an application interview.
void	completeInterview(curam.application.facade.struct.CompleteInterviewDetails completeInterview) Sets the status of an application interview to completed.
void	createAttachment(curam.application.facade.struct.ApplicationAttachmentDetails dtls) Creates an attachment for an application using the details provided.
curam.application.facade.struct.InterviewKey	createInterview(curam.application.facade.struct.InterviewDetails details) Create interview for an application.
void	createNewOwner(curam.application.facade.struct.CreateNewRoleDetails details) Creates a new application role of type APPLICATIONROLETYPEEntry#APPLICATIONOWNER for an application for the specified User or OrgObject.
void	deleteInterviewAttendee1(curam.application.facade.struct.InterviewAttendeeKey key) Removes an attendee from an application interview.
curam.application.facade.struct.ApplyPathDetails	determineApplicationFlow(curam.application.facade.struct.ApplyProgramKey key) Determines if the apply path should follow the path that creates an application case or an integrated case.
void	editInterview(curam.application.facade.struct.InterviewDetails details) Modifies the details of an interview.
void	editSpecialRequirements(curam.application.facade.struct.EditSpecialRequirement specialRequirements) Modifies the details of the special requirements recorded against an application.
curam.application.facade.struct.ApplicationDisplayDtls	getApplicationDetails(curam.application.facade.struct.IEGExecutionApplicationDetails executionID) Retrieves the application record corresponding to the specified IEG execution ID.
curam.application.facade.struct.ApplicationPreviewPanelDetails	getApplicationListPreviewPanelDetails(curam.application.facade.struct.ApplicationKey key) Retrieves the application preview panel details for display based on the application type and status.
curam.application.facade.struct.IEGExecutionConcernRoleDtls	getConcernRoleIDByIEGExecutionID(curam.application.facade.struct.IEGExecutionApplicationDetails iegExecutionID) Reads the concern role ID associated with the specified IEG execution ID.
curam.application.facade.struct.AvailableProgramApplicationList	getConfiguredProgramTypesForApplicationType(curam.application.facade.struct.ApplicationKey key) Reads the configured program application types for an application.
curam.application.facade.struct.InformationalMsgDtlsList	getInterviewInformational(curam.application.entity.struct.ApplicationKey key) Reads the informational details to be displayed when the interview times requested by the client are viewed.
curam.screening.facade.struct.CodeTableCodeDescriptionDetailsList	getOptionsForSaveApplication() Lists the options that can be performed when exiting an application script execution.
curam.application.facade.struct.RightsAndResponsibilitiesDetails	getRightsAndResponsibilitiesTextFields(curam.application.facade.struct.IEGExecutionApplicationDetails iegExecutionID) Reads the details of the rights and responsibility text fields for a specified execution.
void	inviteInterviewAttendee(curam.application.facade.struct.InviteInterviewAttendee details) Invites a proposed attendee to an interview.
curam.application.facade.struct.ApplicationInterviewDetails1	listApplicationInterview1(curam.application.facade.struct.ApplicationKey key) Reads a list of interviews for an application.
curam.application.facade.struct.ApplicationDisplayDtlsForPersonList1	listApplicationsForPerson1(curam.core.sl.struct.ConcernRoleIDKey concernRoleID) Reads a list of applications by concern role.
curam.application.facade.struct.ApplicationAttachmentDetailsList	listAttachments(curam.application.entity.struct.ApplicationKey listAttachmentsKey) Reads a list of attachment for an application.
curam.application.facade.struct.ClientList	listInviteClient(curam.application.facade.struct.InterviewKey key) Reads a list of clients who can be invited to an application interview.
curam.application.facade.struct.UserList	listInviteUsers(curam.application.facade.struct.ApplicationKey key) Reads a list of the system users who can be invited to an application interview.
curam.application.facade.struct.InterviewFullDetails	listPotentialInterviewAttendees(curam.application.facade.struct.ApplicationKey key) Reads a list of attendees that can potentially be invited to an application interview.
curam.application.facade.struct.ApplicationRoleDetailsList	listRoles(curam.application.facade.struct.ApplicationKey key) Reads a list of application roles for an application.
void	modifyApplicationSpecificDetails(curam.application.facade.struct.ModifyApplicationSpecificDetails details) Modifies the application details.
void	modifyAttachment(curam.application.facade.struct.ApplicationAttachmentDetails dtls) Modifies the details of an existing application attachment.
void	modifyRoleDetails(curam.application.facade.struct.ModifyRoleDetails details) Modifies the details of an application role for an application.
void	quitApplication(curam.application.facade.struct.IEGExecutionApplicationDetails key, curam.screening.facade.struct.CodeTableCodeDescriptionDetails details) Cancels an application.
curam.application.facade.struct.CalendarDataDetails	readApplicationCalendarData(curam.application.facade.struct.ApplicationKey key) Reads calendar events associated with an application.
curam.application.facade.struct.ApplicationTabDescription	readApplicationTabDescription(curam.application.facade.struct.ApplicationKey key) Reads the application tab description.
curam.application.facade.struct.ApplicationAttachmentDetails	readAttachment(curam.attachmentlink.struct.AttachmentLinkKey key) Reads the details of an attachment for an application.
curam.application.facade.struct.ReadDetailsForRole	readDetailsForRole(curam.application.facade.struct.ReadByApplicationRoleKey key) Reads the details of an application role.
curam.application.facade.struct.ReadForInviteAttendeeDetails	readForInviteAttendee(curam.application.facade.struct.InterviewKey key) Reads a list of the attendees that can be invited to the application interview.
curam.application.facade.struct.InterviewFullDetails	readInterviewDetails(curam.application.facade.struct.InterviewKey interviewID) Reads the details of an application interview.
curam.application.facade.struct.ModifyApplicationSpecificDetails	readModifyApplicationSpecificDetails(curam.application.facade.struct.ApplicationKey key) Reads a subset of the application details for modification.
curam.application.facade.struct.AvailableProgramApplicationList	readProgramAppTypesForAppType(curam.application.facade.struct.ApplicationTypeKey applicationTypeKey) Reads the program types configured for the specified application type.
curam.application.facade.struct.AvailableProgramApplicationList	readProgramAppTypesForCaseApplication(curam.application.facade.struct.ApplicationForCaseTypeKey applicationForCaseTypeKey) Reads the program types configured for a case.
curam.application.facade.struct.ReadSpecialRequirement	readSpecialRequirements(curam.application.facade.struct.ApplicationKey key) Reads the details of any special requirements associated with an application.
curam.application.facade.struct.AvailableApplicationsList	readStartApplication(curam.core.sl.struct.ConcernRoleIDKey concernRole) Reads all the applications types which have been configured by the organisation.
curam.application.facade.struct.AvailableApplicationsForCase	readStartApplicationForCase(curam.struct.ConcernRoleIDCaseIDKey concernRoleIDCaseIDKey) Reads all the applications types that are configured for a specified case.
curam.application.facade.struct.ResolveApplicationDetails	resolveStartApplication(curam.core.sl.struct.ConcernRoleIDKey key) Resolves what page should be invoked during the start application process.
void	setReadyForDetermination(curam.application.facade.struct.ApplicationKey key) Sets the application to a state of ready for determination.
curam.application.facade.struct.IEGExecutionApplicationDetails	startApplication(curam.application.facade.struct.SelectedApplicationDetails key, curam.core.sl.struct.ConcernRoleIDKey concernRoleIDkey) Sets up the Application based on the information supplied.
curam.application.facade.struct.IEGExecutionApplicationDetails	startApplicationForCase(curam.application.facade.struct.SelectedApplicationDetails key, curam.struct.ConcernRoleIDCaseIDKey concernRoleIDCaseIDkey) Starts an application for a case based on the information supplied.
curam.application.facade.struct.ApplicationID	submitAdditionalApplicationForCase(curam.application.facade.struct.SubmitApplicationDetails details) Submits the application for a case for Approval.
curam.application.facade.struct.ApplicationID	submitApplication1(curam.application.facade.struct.SubmitApplicationDetails details) Submits an application.
curam.application.facade.struct.ApplicationID	submitApplicationForCase(curam.application.facade.struct.SubmitApplicationDetails details) Deprecated. since 6.0 SP1 EP1 replaced by .Application #submitApplicationForCase1(final SubmitApplicationDetails). See release note CR00277619.
curam.application.facade.struct.ApplicationID	submitApplicationForCase1(curam.application.facade.struct.SubmitApplicationDetails details) Submits an application for a case.
void	taskAllocationToCurrentUser(curam.application.facade.struct.ApplicationTask key) Assigns the specified application task to the current user.
void	validateSelectApplicationTypes(curam.application.facade.struct.ApplicationTypeKey applicationTypeKey) Validates that an application type has been specified.
void	validateSelectApplicationTypesForCase(curam.application.facade.struct.ApplicationTypeKey applicationTypeKey) Validates that an application type has been specified.
void	validateSelectProgramTypes(curam.application.facade.struct.ProgramTypeKey programTypeKey) Validates that a program type has been selected.
curam.core.struct.AttachmentDtls	viewAnswersPDF(curam.core.struct.AttachmentKey key) Reads an attachment.
curam.application.facade.struct.ViewDetailsFromCalendar	viewDetailsFromCalendar(curam.application.facade.struct.InterviewKey key) Reads for an application interview's details.
curam.application.facade.struct.AttendeeDetailsList	viewInterviewAttendees(curam.application.facade.struct.InterviewKey key) Reads the interview attendees for a an application interview.
curam.application.facade.struct.ViewInterviewDetails	viewInterviewDetails(curam.application.facade.struct.InterviewKey key) Reads a subset of details pertaining to an application interview.
curam.application.facade.struct.InterviewNotes	viewInterviewNote(curam.application.facade.struct.InterviewKey interviewID) Reads the notes for an application interview.

Method Detail

readStartApplication

curam.application.facade.struct.AvailableApplicationsList readStartApplication(curam.core.sl.struct.ConcernRoleIDKey concernRole)
                                                                        throws curam.util.exception.AppException,
                                                                               curam.util.exception.InformationalException

Reads all the applications types which have been configured by the organisation. This includes a list of all programs associated with each application type.

Parameters:

concernRoleIDKey - Identifies the person to list the applications for.

Returns:

Returns application types.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

startApplication

curam.application.facade.struct.IEGExecutionApplicationDetails startApplication(curam.application.facade.struct.SelectedApplicationDetails key,
                                                                                curam.core.sl.struct.ConcernRoleIDKey concernRoleIDkey)
                                                                         throws curam.util.exception.AppException,
                                                                                curam.util.exception.InformationalException

Sets up the Application based on the information supplied. This involves the creation of:

• ProgramApplications.
• The primary IntakeApplicant.
• The datastore entities.
• The IEG script execution.

Parameters:

key - The selected application details.

concernRoleKey - Identifies the person to list the applications for.

Returns:

The IEG execution details

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

readProgramAppTypesForAppType

curam.application.facade.struct.AvailableProgramApplicationList readProgramAppTypesForAppType(curam.application.facade.struct.ApplicationTypeKey applicationTypeKey)
                                                                                       throws curam.util.exception.AppException,
                                                                                              curam.util.exception.InformationalException

Reads the program types configured for the specified application type.

Parameters:

applicationTypeKey - The application type for which the program types are being sought.

Returns:

A list of program types for the specified application type.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

setReadyForDetermination

void setReadyForDetermination(curam.application.facade.struct.ApplicationKey key)
                       throws curam.util.exception.AppException,
                              curam.util.exception.InformationalException

Sets the application to a state of ready for determination.

Parameters:

key - Unique identifier for the application.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

validateSelectApplicationTypes

void validateSelectApplicationTypes(curam.application.facade.struct.ApplicationTypeKey applicationTypeKey)
                             throws curam.util.exception.AppException,
                                    curam.util.exception.InformationalException

Validates that an application type has been specified.

Parameters:

key - Identifies the application type.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

validateSelectProgramTypes

void validateSelectProgramTypes(curam.application.facade.struct.ProgramTypeKey programTypeKey)
                         throws curam.util.exception.AppException,
                                curam.util.exception.InformationalException

Validates that a program type has been selected.

Parameters:

key - Identifies the program type.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

getConcernRoleIDByIEGExecutionID

curam.application.facade.struct.IEGExecutionConcernRoleDtls getConcernRoleIDByIEGExecutionID(curam.application.facade.struct.IEGExecutionApplicationDetails iegExecutionID)
                                                                                      throws curam.util.exception.AppException,
                                                                                             curam.util.exception.InformationalException

Reads the concern role ID associated with the specified IEG execution ID.

Parameters:

iegExecutionID - The key of the IEG execution.

Returns:

The concern role ID and an indicator depicting whether the concern role is registered.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

getApplicationListPreviewPanelDetails

curam.application.facade.struct.ApplicationPreviewPanelDetails getApplicationListPreviewPanelDetails(curam.application.facade.struct.ApplicationKey key)
                                                                                              throws curam.util.exception.AppException,
                                                                                                     curam.util.exception.InformationalException

Retrieves the application preview panel details for display based on the application type and status.

Parameters:

key - The key of application to be read.

Returns:

The details of the application preview panel.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

cancelApplication

void cancelApplication(curam.application.facade.struct.CancelApplication cancelApplication)
                throws curam.util.exception.AppException,
                       curam.util.exception.InformationalException

Cancels an application.

Parameters:

key - The unique identifier of the application to be canceled.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

getRightsAndResponsibilitiesTextFields

curam.application.facade.struct.RightsAndResponsibilitiesDetails getRightsAndResponsibilitiesTextFields(curam.application.facade.struct.IEGExecutionApplicationDetails iegExecutionID)
                                                                                                 throws curam.util.exception.AppException,
                                                                                                        curam.util.exception.InformationalException

Reads the details of the rights and responsibility text fields for a specified execution.

Parameters:

They - key of the IEG execution.

Returns:

The details of the rights and responsibilities.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

taskAllocationToCurrentUser

void taskAllocationToCurrentUser(curam.application.facade.struct.ApplicationTask key)
                          throws curam.util.exception.AppException,
                                 curam.util.exception.InformationalException

Assigns the specified application task to the current user.

Parameters:

key - Unique identifier for the application and task being assigned.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

quitApplication

void quitApplication(curam.application.facade.struct.IEGExecutionApplicationDetails key,
                     curam.screening.facade.struct.CodeTableCodeDescriptionDetails details)
              throws curam.util.exception.AppException,
                     curam.util.exception.InformationalException

Cancels an application.

Parameters:

iegExecutionIDKey - The key of the IEG script execution.

details - The code table value of the selection made by the user, e.g. SAVEAPPLICATIONOPTIONEntry#QUITWITHOUTSAVING.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

createInterview

curam.application.facade.struct.InterviewKey createInterview(curam.application.facade.struct.InterviewDetails details)
                                                      throws curam.util.exception.AppException,
                                                             curam.util.exception.InformationalException

Create interview for an application.

Parameters:

details - The interview details to be created.

Returns:

The unique identifier of the interview.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

editInterview

void editInterview(curam.application.facade.struct.InterviewDetails details)
            throws curam.util.exception.AppException,
                   curam.util.exception.InformationalException

Modifies the details of an interview.

Parameters:

details - The interview details to be modified.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

inviteInterviewAttendee

void inviteInterviewAttendee(curam.application.facade.struct.InviteInterviewAttendee details)
                      throws curam.util.exception.AppException,
                             curam.util.exception.InformationalException

Invites a proposed attendee to an interview.

Parameters:

details - The details of the interview and the attendee to be invited.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

editSpecialRequirements

void editSpecialRequirements(curam.application.facade.struct.EditSpecialRequirement specialRequirements)
                      throws curam.util.exception.AppException,
                             curam.util.exception.InformationalException

Modifies the details of the special requirements recorded against an application. An example of a special requirement would be that the applicant requires an interpreter to be present for their interview.

Parameters:

details - The details of the special requirement to be modified.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

viewInterviewDetails

curam.application.facade.struct.ViewInterviewDetails viewInterviewDetails(curam.application.facade.struct.InterviewKey key)
                                                                   throws curam.util.exception.AppException,
                                                                          curam.util.exception.InformationalException

Reads a subset of details pertaining to an application interview.

Parameters:

key - The unique identifier for the application interview.

Returns:

The details of the interview.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

viewInterviewAttendees

curam.application.facade.struct.AttendeeDetailsList viewInterviewAttendees(curam.application.facade.struct.InterviewKey key)
                                                                    throws curam.util.exception.AppException,
                                                                           curam.util.exception.InformationalException

Reads the interview attendees for a an application interview.

Parameters:

key - The unique identifier of the application interview.

Returns:

The list of application interview attendee details.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

completeInterview

void completeInterview(curam.application.facade.struct.CompleteInterviewDetails completeInterview)
                throws curam.util.exception.AppException,
                       curam.util.exception.InformationalException

Sets the status of an application interview to completed.

Parameters:

details - The unique indentifier and version number of the application interview to be completed.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

viewInterviewNote

curam.application.facade.struct.InterviewNotes viewInterviewNote(curam.application.facade.struct.InterviewKey interviewID)
                                                          throws curam.util.exception.AppException,
                                                                 curam.util.exception.InformationalException

Reads the notes for an application interview.

Parameters:

key - The unique identifier of the application interview.

Returns:

The note details for the application interview.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

readStartApplicationForCase

curam.application.facade.struct.AvailableApplicationsForCase readStartApplicationForCase(curam.struct.ConcernRoleIDCaseIDKey concernRoleIDCaseIDKey)
                                                                                  throws curam.util.exception.AppException,
                                                                                         curam.util.exception.InformationalException

Reads all the applications types that are configured for a specified case. This includes a list of all program associated with each application type.

Parameters:

concernRoleIDCaseIDKey - Identifies the person and case to list the applications for.

Returns:

List of application types.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

readProgramAppTypesForCaseApplication

curam.application.facade.struct.AvailableProgramApplicationList readProgramAppTypesForCaseApplication(curam.application.facade.struct.ApplicationForCaseTypeKey applicationForCaseTypeKey)
                                                                                               throws curam.util.exception.AppException,
                                                                                                      curam.util.exception.InformationalException

Reads the program types configured for a case.

Parameters:

applicationForCaseTypeKey - The unique identifier of the case.

Returns:

A list of program types.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

startApplicationForCase

curam.application.facade.struct.IEGExecutionApplicationDetails startApplicationForCase(curam.application.facade.struct.SelectedApplicationDetails key,
                                                                                       curam.struct.ConcernRoleIDCaseIDKey concernRoleIDCaseIDkey)
                                                                                throws curam.util.exception.AppException,
                                                                                       curam.util.exception.InformationalException

Starts an application for a case based on the information supplied. This involves the creation of:

• ProgramApplications.
• The primary IntakeApplicant.
• The datastore entities.
• The IEG script execution.

Parameters:

key - The details of the application to be started.

concernRoleIDCaseIDkey - The unique identifier of both the case and concern for whom application should be started.

Returns:

The IEG execution details.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

submitApplicationForCase

@Deprecated
curam.application.facade.struct.ApplicationID submitApplicationForCase(curam.application.facade.struct.SubmitApplicationDetails details)
                                                                            throws curam.util.exception.AppException,
                                                                                   curam.util.exception.InformationalException

Deprecated. since 6.0 SP1 EP1 replaced by .Application #submitApplicationForCase1(final SubmitApplicationDetails). See release note CR00277619.

Submits the application for a case for Approval.

Parameters:

details - Contains the IEG execution id and the rights and responsibilities indicators.

Returns:

the application ID.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

getOptionsForSaveApplication

curam.screening.facade.struct.CodeTableCodeDescriptionDetailsList getOptionsForSaveApplication()
                                                                                        throws curam.util.exception.AppException,
                                                                                               curam.util.exception.InformationalException

Lists the options that can be performed when exiting an application script execution.

Returns:

A list of codetable codes and descriptions.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

viewAnswersPDF

curam.core.struct.AttachmentDtls viewAnswersPDF(curam.core.struct.AttachmentKey key)
                                         throws curam.util.exception.AppException,
                                                curam.util.exception.InformationalException

Reads an attachment.

Parameters:

attachmentKey - Unique identifier for the attachment.

Returns:

The details of the attachment.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

createAttachment

void createAttachment(curam.application.facade.struct.ApplicationAttachmentDetails dtls)
               throws curam.util.exception.AppException,
                      curam.util.exception.InformationalException

Creates an attachment for an application using the details provided.

Parameters:

dtls - The attachment details and the unique identifier of the application for which it will be linked.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

listAttachments

curam.application.facade.struct.ApplicationAttachmentDetailsList listAttachments(curam.application.entity.struct.ApplicationKey listAttachmentsKey)
                                                                          throws curam.util.exception.AppException,
                                                                                 curam.util.exception.InformationalException

Reads a list of attachment for an application.

Parameters:

key - The unique identifier of the application.

Returns:

A list of attachment details.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

readAttachment

curam.application.facade.struct.ApplicationAttachmentDetails readAttachment(curam.attachmentlink.struct.AttachmentLinkKey key)
                                                                     throws curam.util.exception.AppException,
                                                                            curam.util.exception.InformationalException

Reads the details of an attachment for an application.

Parameters:

key - The key to the application attachment.

Returns:

The details of the attachment.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

modifyAttachment

void modifyAttachment(curam.application.facade.struct.ApplicationAttachmentDetails dtls)
               throws curam.util.exception.AppException,
                      curam.util.exception.InformationalException

Modifies the details of an existing application attachment.

Parameters:

dtls - The attachment details to be modified.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

cancelAttachment

void cancelAttachment(curam.attachmentlink.struct.AttachmentLinkKey key)
               throws curam.util.exception.AppException,
                      curam.util.exception.InformationalException

Cancels an application attachment.

Parameters:

key - The unique identifier of the attachment link used to cancel the attachment.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

cancelInterview

void cancelInterview(curam.application.facade.struct.CancelInterviewDetails details)
              throws curam.util.exception.AppException,
                     curam.util.exception.InformationalException

Cancels an existing instance of an application interview.

Parameters:

details - The details of the Interview to be canceled.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

readForInviteAttendee

curam.application.facade.struct.ReadForInviteAttendeeDetails readForInviteAttendee(curam.application.facade.struct.InterviewKey key)
                                                                            throws curam.util.exception.AppException,
                                                                                   curam.util.exception.InformationalException

Reads a list of the attendees that can be invited to the application interview.

Parameters:

InterviewKey - The unique identifier of the application interview.

Returns:

A list of the attendees that can be invited to the application interview.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

validateSelectApplicationTypesForCase

void validateSelectApplicationTypesForCase(curam.application.facade.struct.ApplicationTypeKey applicationTypeKey)
                                    throws curam.util.exception.AppException,
                                           curam.util.exception.InformationalException

Validates that an application type has been specified.

Parameters:

key - Identifies the application type.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

resolveStartApplication

curam.application.facade.struct.ResolveApplicationDetails resolveStartApplication(curam.core.sl.struct.ConcernRoleIDKey key)
                                                                           throws curam.util.exception.AppException,
                                                                                  curam.util.exception.InformationalException

Resolves what page should be invoked during the start application process.

Parameters:

key - The unique identifier for the concern role for whom the application has been started.

Returns:

The details of the pages to be displayed.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

readApplicationTabDescription

curam.application.facade.struct.ApplicationTabDescription readApplicationTabDescription(curam.application.facade.struct.ApplicationKey key)
                                                                                 throws curam.util.exception.AppException,
                                                                                        curam.util.exception.InformationalException

Reads the application tab description.

Parameters:

key - The unique identifier of the application.

Returns:

The application tab description.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

assignToMe

void assignToMe(curam.application.facade.struct.ApplicationKey key)
         throws curam.util.exception.AppException,
                curam.util.exception.InformationalException

Assigns the application to the current user. The current user is defined as the owner of the current transaction, this can be the user who is logged into the system or it can be the system itself.

Parameters:

key - The key of the application to be assigned.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

getInterviewInformational

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

Reads the informational details to be displayed when the interview times requested by the client are viewed.

Parameters:

key - The unique identification of the application.

Returns:

The informational details to be displayed when the interview times requested by the client are viewed.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

readSpecialRequirements

curam.application.facade.struct.ReadSpecialRequirement readSpecialRequirements(curam.application.facade.struct.ApplicationKey key)
                                                                        throws curam.util.exception.AppException,
                                                                               curam.util.exception.InformationalException

Reads the details of any special requirements associated with an application. Generally special requirements are in the context of a client attending an interview, for example a client may need an interpreter.

Parameters:

key - The unique identifier of the application.

Returns:

The details of any special requirements associated with an application.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

getConfiguredProgramTypesForApplicationType

curam.application.facade.struct.AvailableProgramApplicationList getConfiguredProgramTypesForApplicationType(curam.application.facade.struct.ApplicationKey key)
                                                                                                     throws curam.util.exception.AppException,
                                                                                                            curam.util.exception.InformationalException

Reads the configured program application types for an application.

Parameters:

key - The unique identifier of the application.

Returns:

List of program applications configure for the specified application.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

listApplicationInterview1

curam.application.facade.struct.ApplicationInterviewDetails1 listApplicationInterview1(curam.application.facade.struct.ApplicationKey key)
                                                                                throws curam.util.exception.AppException,
                                                                                       curam.util.exception.InformationalException

Reads a list of interviews for an application.

Parameters:

key - The unique identifier of the application.

Returns:

A list of interviews for the specified application.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

submitApplication1

curam.application.facade.struct.ApplicationID submitApplication1(curam.application.facade.struct.SubmitApplicationDetails details)
                                                          throws curam.util.exception.AppException,
                                                                 curam.util.exception.InformationalException

Submits an application. The successful submission of an application will cause the following:

• The creation of an integrated case.
• The creation of intake applicant records.
• The creation of program application records.
• The creation of evidence records/

Parameters:

details - The IEG execution id and the rights and responsibilities indicators.

Returns:

The unique identifier of the application.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

submitApplicationForCase1

curam.application.facade.struct.ApplicationID submitApplicationForCase1(curam.application.facade.struct.SubmitApplicationDetails details)
                                                                 throws curam.util.exception.AppException,
                                                                        curam.util.exception.InformationalException

Submits an application for a case. The successful submission of an application will cause the following:

• The creation of an integrated case.
• The creation of intake applicant records.
• The creation of program application records.
• The creation of evidence records/

Parameters:

details - The IEG execution id and the rights and responsibilities indicators.

Returns:

The unique identifier of the application.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

listInviteUsers

curam.application.facade.struct.UserList listInviteUsers(curam.application.facade.struct.ApplicationKey key)
                                                  throws curam.util.exception.AppException,
                                                         curam.util.exception.InformationalException

Reads a list of the system users who can be invited to an application interview.

Parameters:

key - The unique identifier of the application interview.

Returns:

A list of system users.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

listInviteClient

curam.application.facade.struct.ClientList listInviteClient(curam.application.facade.struct.InterviewKey key)
                                                     throws curam.util.exception.AppException,
                                                            curam.util.exception.InformationalException

Reads a list of clients who can be invited to an application interview.

Parameters:

key - The unique indentifier for an application. interview.

Returns:

A list of clients.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

deleteInterviewAttendee1

void deleteInterviewAttendee1(curam.application.facade.struct.InterviewAttendeeKey key)
                       throws curam.util.exception.AppException,
                              curam.util.exception.InformationalException

Removes an attendee from an application interview.

Parameters:

key - The unique identifiers for both the interview and the attendee.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

viewDetailsFromCalendar

curam.application.facade.struct.ViewDetailsFromCalendar viewDetailsFromCalendar(curam.application.facade.struct.InterviewKey key)
                                                                         throws curam.util.exception.AppException,
                                                                                curam.util.exception.InformationalException

Reads for an application interview's details.

Parameters:

key - The unique identifier of the application interview.

Returns:

The application interview's details.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

readModifyApplicationSpecificDetails

curam.application.facade.struct.ModifyApplicationSpecificDetails readModifyApplicationSpecificDetails(curam.application.facade.struct.ApplicationKey key)
                                                                                               throws curam.util.exception.AppException,
                                                                                                      curam.util.exception.InformationalException

Reads a subset of the application details for modification.

Parameters:

key - The unique identifier of the application.

Returns:

The subset of the application details.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

modifyApplicationSpecificDetails

void modifyApplicationSpecificDetails(curam.application.facade.struct.ModifyApplicationSpecificDetails details)
                               throws curam.util.exception.AppException,
                                      curam.util.exception.InformationalException

Modifies the application details.

Parameters:

details - The application details to be modified.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

modifyRoleDetails

void modifyRoleDetails(curam.application.facade.struct.ModifyRoleDetails details)
                throws curam.util.exception.AppException,
                       curam.util.exception.InformationalException

Modifies the details of an application role for an application.

Parameters:

details - The details of the application role to be modified.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

listRoles

curam.application.facade.struct.ApplicationRoleDetailsList listRoles(curam.application.facade.struct.ApplicationKey key)
                                                              throws curam.util.exception.AppException,
                                                                     curam.util.exception.InformationalException

Reads a list of application roles for an application.

Parameters:

key - The unique identifier of the application.

Returns:

A list of application role records.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

readDetailsForRole

curam.application.facade.struct.ReadDetailsForRole readDetailsForRole(curam.application.facade.struct.ReadByApplicationRoleKey key)
                                                               throws curam.util.exception.AppException,
                                                                      curam.util.exception.InformationalException

Reads the details of an application role.

Parameters:

key - The unique identifier of the application role.

Returns:

The application role details.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

createNewOwner

void createNewOwner(curam.application.facade.struct.CreateNewRoleDetails details)
             throws curam.util.exception.AppException,
                    curam.util.exception.InformationalException

Creates a new application role of type APPLICATIONROLETYPEEntry#APPLICATIONOWNER for an application for the specified User or OrgObject.

Parameters:

details - The details of the application owner to be created.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

listApplicationsForPerson1

curam.application.facade.struct.ApplicationDisplayDtlsForPersonList1 listApplicationsForPerson1(curam.core.sl.struct.ConcernRoleIDKey concernRoleID)
                                                                                         throws curam.util.exception.AppException,
                                                                                                curam.util.exception.InformationalException

Reads a list of applications by concern role.

Parameters:

key - The unique identifier of the concern role.

Returns:

A list of applications.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

readApplicationCalendarData

curam.application.facade.struct.CalendarDataDetails readApplicationCalendarData(curam.application.facade.struct.ApplicationKey key)
                                                                         throws curam.util.exception.AppException,
                                                                                curam.util.exception.InformationalException

Reads calendar events associated with an application.

Parameters:

key - The unique identifier of the application.

Returns:

The calendar events associated with an application.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

readInterviewDetails

curam.application.facade.struct.InterviewFullDetails readInterviewDetails(curam.application.facade.struct.InterviewKey interviewID)
                                                                   throws curam.util.exception.AppException,
                                                                          curam.util.exception.InformationalException

Reads the details of an application interview.

Parameters:

key - The unique indentifier of the interview.

Returns:

The details of the interview.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

listPotentialInterviewAttendees

curam.application.facade.struct.InterviewFullDetails listPotentialInterviewAttendees(curam.application.facade.struct.ApplicationKey key)
                                                                              throws curam.util.exception.AppException,
                                                                                     curam.util.exception.InformationalException

Reads a list of attendees that can potentially be invited to an application interview.

Parameters:

ApplicationKey - The unique identifier for the application.

Returns:

A list of potential interview attendees.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

determineApplicationFlow

curam.application.facade.struct.ApplyPathDetails determineApplicationFlow(curam.application.facade.struct.ApplyProgramKey key)
                                                                   throws curam.util.exception.AppException,
                                                                          curam.util.exception.InformationalException

Determines if the apply path should follow the path that creates an application case or an integrated case. If an creation of an application case is the path configured, the URI required will also be returned.

Parameters:

key - The program type being applied for, and the unique identifier of the person for whom the application is for.

Returns:

An indicator stating whether or not an application case should be created, and the URI required to do so if configured as such.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

submitAdditionalApplicationForCase

curam.application.facade.struct.ApplicationID submitAdditionalApplicationForCase(curam.application.facade.struct.SubmitApplicationDetails details)
                                                                          throws curam.util.exception.AppException,
                                                                                 curam.util.exception.InformationalException

Submits the application for a case for Approval.

Parameters:

details - Contains the IEG execution id and the rights and responsibilities indicators.

Returns:

the application ID.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

getApplicationDetails

curam.application.facade.struct.ApplicationDisplayDtls getApplicationDetails(curam.application.facade.struct.IEGExecutionApplicationDetails executionID)
                                                                      throws curam.util.exception.AppException,
                                                                             curam.util.exception.InformationalException

Retrieves the application record corresponding to the specified IEG execution ID.

Parameters:

executionID - The key of the IEG execution.

Returns:

The Application Display Details.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException