curam.commonintake.authorisation.facade.intf

Interface ApplicationAuthorisation

All Known Implementing Classes:

ApplicationAuthorisation, curam.commonintake.authorisation.facade.impl.ApplicationAuthorisation, ApplicationAuthorisationFactory

public interface ApplicationAuthorisation

Provides the ability to authorize at the application case level.

Method Summary

Modifier and Type	Method and Description
void	authorise(curam.commonintake.authorisation.facade.struct.AuthorisationDetails details) Authorizes the application case based on the results of the application authorization ruleset.
void	authorizeWithNoProgram() Invokes the authorization process for the selected program.
curam.commonintake.authorisation.facade.struct.AuthorisationDisplayDetails	getAuthorisationDisplayDetails(curam.commonintake.entity.struct.ApplicationCaseKey key) Retrieves the authorization modal window details.
curam.commonintake.authorisation.facade.struct.AuthorisationURI	getAuthorisationURI(curam.commonintake.entity.struct.ApplicationCaseKey key) Retrieves the URI that should be invoked when the application authorization is requested.
curam.commonintake.authorisation.facade.struct.ApplicationDenialDetails	listApplicationDenials(curam.commonintake.entity.struct.ApplicationCaseKey key) Retrieves a list of program denials for the application case.
curam.commonintake.authorisation.facade.struct.ApplicationReopeningDetails	listApplicationReopenings(curam.commonintake.entity.struct.ApplicationCaseKey key) Retrieves a list of reopenings for the application case.
curam.commonintake.authorisation.facade.struct.ApplicationWithdrawalDetails	listApplicationWithdrawals(curam.commonintake.entity.struct.ApplicationCaseKey key) Retrieves a list of withdrawals for the application case.
curam.commonintake.authorisation.facade.struct.AuthorisationExistingCasesList	listClientsExistingCases(curam.commonintake.entity.struct.ApplicationCaseKey caseKey) Retrieves a list of active integrated cases for the clients on the application case.
curam.commonintake.authorisation.facade.struct.ApplicationAuthorisationDetails	viewAuthorisationDetails(curam.commonintake.entity.struct.ApplicationCaseKey key) Reads the latest authorisation details for the given application case.

Method Detail

authorise

void authorise(curam.commonintake.authorisation.facade.struct.AuthorisationDetails details)
        throws curam.util.exception.AppException,
               curam.util.exception.InformationalException

Authorizes the application case based on the results of the application authorization ruleset.

Parameters:

details - The application case identifier, the ongoing case identifier, if required, and comments relating to the authorization.

Throws:

curam.util.exception.AppException - Generic Exception.

curam.util.exception.InformationalException - Generic Exception.

getAuthorisationURI

curam.commonintake.authorisation.facade.struct.AuthorisationURI getAuthorisationURI(curam.commonintake.entity.struct.ApplicationCaseKey key)
                                                                             throws curam.util.exception.AppException,
                                                                                    curam.util.exception.InformationalException

Retrieves the URI that should be invoked when the application authorization is requested.

Parameters:

key - The unique identifier of the application case.

Returns:

The URI that should be invoked when the application authorization is requested.

Throws:

curam.util.exception.AppException - Generic Exception.

curam.util.exception.InformationalException - Generic Exception.

listClientsExistingCases

curam.commonintake.authorisation.facade.struct.AuthorisationExistingCasesList listClientsExistingCases(curam.commonintake.entity.struct.ApplicationCaseKey caseKey)
                                                                                                throws curam.util.exception.AppException,
                                                                                                       curam.util.exception.InformationalException

Retrieves a list of active integrated cases for the clients on the application case.

Parameters:

caseKey - The application case identifier.

Returns:

A list of all existing integrated cases for the client.

Throws:

curam.util.exception.AppException - Generic Exception.

curam.util.exception.InformationalException - Generic Exception.

viewAuthorisationDetails

curam.commonintake.authorisation.facade.struct.ApplicationAuthorisationDetails viewAuthorisationDetails(curam.commonintake.entity.struct.ApplicationCaseKey key)
                                                                                                 throws curam.util.exception.AppException,
                                                                                                        curam.util.exception.InformationalException

Reads the latest authorisation details for the given application case.

Parameters:

key - The unique identifier of the application case.

Returns:

The details of the authorisation for the application case.

Throws:

curam.util.exception.AppException - Generic Exception.

curam.util.exception.InformationalException - Generic Exception.

listApplicationDenials

curam.commonintake.authorisation.facade.struct.ApplicationDenialDetails listApplicationDenials(curam.commonintake.entity.struct.ApplicationCaseKey key)
                                                                                        throws curam.util.exception.AppException,
                                                                                               curam.util.exception.InformationalException

Retrieves a list of program denials for the application case.

Parameters:

key - The unqiue identifier of the application case.

Returns:

A list of program denials for the application case.

Throws:

curam.util.exception.AppException - Generic Exception.

curam.util.exception.InformationalException - Generic Exception.

listApplicationWithdrawals

curam.commonintake.authorisation.facade.struct.ApplicationWithdrawalDetails listApplicationWithdrawals(curam.commonintake.entity.struct.ApplicationCaseKey key)
                                                                                                throws curam.util.exception.AppException,
                                                                                                       curam.util.exception.InformationalException

Retrieves a list of withdrawals for the application case.

Parameters:

key - The unqiue identifier of the application case.

Returns:

A list of programs which have been withdrawn.

Throws:

curam.util.exception.AppException - Generic Exception.

curam.util.exception.InformationalException - Generic Exception.

listApplicationReopenings

curam.commonintake.authorisation.facade.struct.ApplicationReopeningDetails listApplicationReopenings(curam.commonintake.entity.struct.ApplicationCaseKey key)
                                                                                              throws curam.util.exception.AppException,
                                                                                                     curam.util.exception.InformationalException

Retrieves a list of reopenings for the application case.

Parameters:

key - The unqiue identifier of the application case.

Returns:

A list of programs which have been reopened.

Throws:

curam.util.exception.AppException - Generic Exception.

curam.util.exception.InformationalException - Generic Exception.

getAuthorisationDisplayDetails

curam.commonintake.authorisation.facade.struct.AuthorisationDisplayDetails getAuthorisationDisplayDetails(curam.commonintake.entity.struct.ApplicationCaseKey key)
                                                                                                   throws curam.util.exception.AppException,
                                                                                                          curam.util.exception.InformationalException

Retrieves the authorization modal window details.

Parameters:

caseKey - The application case identifier.

Returns:

Authorization modal window details.

Throws:

curam.util.exception.AppException - Generic Exception.

curam.util.exception.InformationalException - Generic Exception.

authorizeWithNoProgram

void authorizeWithNoProgram()
                     throws curam.util.exception.AppException,
                            curam.util.exception.InformationalException

Invokes the authorization process for the selected program.

Parameters:

key - The key containing the details passed in from the client.

Throws:

curam.util.exception.AppException - Generic Exception.

curam.util.exception.InformationalException - Generic Exception.