curam.application.facade.intf

Interface ProgramApplication

All Known Implementing Classes:

ProgramApplication, curam.application.facade.impl.ProgramApplication, ProgramApplicationFactory

public interface ProgramApplication

This business interface provides operations related to program applications.

Method Summary

Modifier and Type	Method and Description
void	addProgram(curam.application.entity.struct.ProgramApplicationDtls details) Adds a program application to an application which is in a state of ReadyForDetermination or Submitted.
void	confirmWithdrawalRequest(curam.application.facade.struct.ProgramWithdrawalRequestDetails details) Confirms the program withdrawal request.
curam.screening.facade.struct.CodeTableCodeDescriptionDetailsList	getReopenStatusTransitionReasons(curam.application.entity.struct.ProgramApplicationKey key) Returns a list of resons for reopening a program application based on the status of the application.
curam.application.facade.struct.ProgramApplicationDetails2List	listProgramApplications2(curam.application.entity.struct.ApplicationKey key) Retrieves the list of program applications for an application.
curam.application.facade.struct.ProgramWithdrawalRequestDetailsList	listProgramWithdrawalRequests(curam.application.entity.struct.ProgramApplicationKey key) Returns a list of program withdrawal request records for a specific program application.
curam.application.facade.struct.ReopenProgramApplicationDetailsList	listReopenings(curam.application.entity.struct.ProgramApplicationKey key) Returns a list of reopening records for the program application.
void	modifyProgramApplicationDetails(curam.application.facade.struct.ModifyProgramApplicationDetails modifyProgramApplicationDetails) Modifies the details of the program application.
void	modifyReopenDetails(curam.application.facade.struct.ModifyReopenProgramApplicationDetails modifyReopenProgramApplicationDetails) Modifies the details of a program application reopening.
curam.application.facade.struct.ProgramApplicationDetails	readProgramApplication(curam.application.entity.struct.ProgramApplicationKey key) Reads all the program application details.
curam.application.facade.struct.ReadWithrawApplicationDetails	readProgramApplicationDetails(curam.application.entity.struct.ProgramApplicationKey key) Reads the list of client details for the application associated with a specific program application.
curam.application.facade.struct.ReadReopenCommentDetails	readReopenCommentsDetails(curam.application.facade.struct.ReadByProgramAppStatusTransitionKey key) Reads the comments of a specific program application reopening.
curam.application.facade.struct.ReadWithdrawalRequestComments	readWithdrawalRequestCommentDetails(curam.application.facade.struct.ReadByProgramWithdrawalRequestKey key) Reads the comments of a specific program application withdrawal.
curam.application.facade.struct.ProgramWithdrawalRequestDetails	readWithdrawalRequestDetailsForConfirmation(curam.application.facade.struct.ProgramWithdrawalRequestKey key) Retrieves the open program withdrawal request details to be confirmed.
void	reopen(curam.application.facade.struct.ProgramApplicationReopenKey key) Reopens a program application that had been withdrawn or denied.
curam.application.facade.struct.ProgramWithdrawalRequestDetails	viewWithdrawalRequest(curam.application.entity.struct.ProgramApplicationKey key) Reads back the details of the open program withdrawal request.
void	withdrawProgramRequest(curam.application.facade.struct.ProgramWithdrawalRequestDetails details) Withdraw program request inserting a program withdrawal request record for a program application.

Method Detail

addProgram

void addProgram(curam.application.entity.struct.ProgramApplicationDtls details)
         throws curam.util.exception.AppException,
                curam.util.exception.InformationalException

Adds a program application to an application which is in a state of ReadyForDetermination or Submitted. The associated program timers are also added.

Parameters:

details - The program application details to be added.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

withdrawProgramRequest

void withdrawProgramRequest(curam.application.facade.struct.ProgramWithdrawalRequestDetails details)
                     throws curam.util.exception.AppException,
                            curam.util.exception.InformationalException

Withdraw program request inserting a program withdrawal request record for a program application.

Parameters:

details - Details of the program withdrawal request to be inserted.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

viewWithdrawalRequest

curam.application.facade.struct.ProgramWithdrawalRequestDetails viewWithdrawalRequest(curam.application.entity.struct.ProgramApplicationKey key)
                                                                               throws curam.util.exception.AppException,
                                                                                      curam.util.exception.InformationalException

Reads back the details of the open program withdrawal request.

Parameters:

key - The unique identifier for the program application.

Returns:

The program withdrawal request details.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

confirmWithdrawalRequest

void confirmWithdrawalRequest(curam.application.facade.struct.ProgramWithdrawalRequestDetails details)
                       throws curam.util.exception.AppException,
                              curam.util.exception.InformationalException

Confirms the program withdrawal request.

Parameters:

details - The details of the program withdrawal request.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

readProgramApplicationDetails

curam.application.facade.struct.ReadWithrawApplicationDetails readProgramApplicationDetails(curam.application.entity.struct.ProgramApplicationKey key)
                                                                                     throws curam.util.exception.AppException,
                                                                                            curam.util.exception.InformationalException

Reads the list of client details for the application associated with a specific program application.

Parameters:

key - The unique identifier of the program application.

Returns:

A list of client detail records.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

readWithdrawalRequestDetailsForConfirmation

curam.application.facade.struct.ProgramWithdrawalRequestDetails readWithdrawalRequestDetailsForConfirmation(curam.application.facade.struct.ProgramWithdrawalRequestKey key)
                                                                                                     throws curam.util.exception.AppException,
                                                                                                            curam.util.exception.InformationalException

Retrieves the open program withdrawal request details to be confirmed.

Parameters:

key - The unique identifier of the program withdrawal request.

Returns:

The program withdrawal request details.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

modifyProgramApplicationDetails

void modifyProgramApplicationDetails(curam.application.facade.struct.ModifyProgramApplicationDetails modifyProgramApplicationDetails)
                              throws curam.util.exception.AppException,
                                     curam.util.exception.InformationalException

Modifies the details of the program application.

Parameters:

modifyProgramApplicationDetails - The details to be modified.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

readProgramApplication

curam.application.facade.struct.ProgramApplicationDetails readProgramApplication(curam.application.entity.struct.ProgramApplicationKey key)
                                                                          throws curam.util.exception.AppException,
                                                                                 curam.util.exception.InformationalException

Reads all the program application details.

Parameters:

key - The unique identifier of the program application.

Returns:

The program application details.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

reopen

void reopen(curam.application.facade.struct.ProgramApplicationReopenKey key)
     throws curam.util.exception.AppException,
            curam.util.exception.InformationalException

Reopens a program application that had been withdrawn or denied. This will update the status of the program application and restart the appropriate timers.

Parameters:

key - The reason and comments for the reopen.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

modifyReopenDetails

void modifyReopenDetails(curam.application.facade.struct.ModifyReopenProgramApplicationDetails modifyReopenProgramApplicationDetails)
                  throws curam.util.exception.AppException,
                         curam.util.exception.InformationalException

Modifies the details of a program application reopening.

Parameters:

modifyReopenProgramApplicationDetails - The details of program application reopen record to be modified.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

listReopenings

curam.application.facade.struct.ReopenProgramApplicationDetailsList listReopenings(curam.application.entity.struct.ProgramApplicationKey key)
                                                                            throws curam.util.exception.AppException,
                                                                                   curam.util.exception.InformationalException

Returns a list of reopening records for the program application. This list will be sorted by the earliest creation date and time.

Parameters:

key - The unique identifier of the program application.

Returns:

List of Reopen records for a program application.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

getReopenStatusTransitionReasons

curam.screening.facade.struct.CodeTableCodeDescriptionDetailsList getReopenStatusTransitionReasons(curam.application.entity.struct.ProgramApplicationKey key)
                                                                                            throws curam.util.exception.AppException,
                                                                                                   curam.util.exception.InformationalException

Returns a list of resons for reopening a program application based on the status of the application.

Parameters:

key - The unique identifier of the program application.

Returns:

The list of reasons and descriptions for reopening a program.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

readReopenCommentsDetails

curam.application.facade.struct.ReadReopenCommentDetails readReopenCommentsDetails(curam.application.facade.struct.ReadByProgramAppStatusTransitionKey key)
                                                                            throws curam.util.exception.AppException,
                                                                                   curam.util.exception.InformationalException

Reads the comments of a specific program application reopening.

Parameters:

key - The unique identifier of the program application.

Returns:

The comment details.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

listProgramWithdrawalRequests

curam.application.facade.struct.ProgramWithdrawalRequestDetailsList listProgramWithdrawalRequests(curam.application.entity.struct.ProgramApplicationKey key)
                                                                                           throws curam.util.exception.AppException,
                                                                                                  curam.util.exception.InformationalException

Returns a list of program withdrawal request records for a specific program application.

Parameters:

key - The unique identifier of the program application.

Returns:

The list of program withdrawal request records.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

readWithdrawalRequestCommentDetails

curam.application.facade.struct.ReadWithdrawalRequestComments readWithdrawalRequestCommentDetails(curam.application.facade.struct.ReadByProgramWithdrawalRequestKey key)
                                                                                           throws curam.util.exception.AppException,
                                                                                                  curam.util.exception.InformationalException

Reads the comments of a specific program application withdrawal.

Parameters:

key - The unique identifier of the program withdrawal request.

Returns:

The reopen comments.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

listProgramApplications2

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

Retrieves the list of program applications for an application.

Parameters:

key - The unique identifier for the application.

Returns:

The list of program application details.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException