curam.commonintake.authorisation.facade.intf

Interface ProgramAuthorisation

All Known Implementing Classes:

ProgramAuthorisation, curam.commonintake.authorisation.facade.impl.ProgramAuthorisation, ProgramAuthorisationFactory

public interface ProgramAuthorisation

Provides the ability to authorize at the program level.

Method Summary

Modifier and Type	Method and Description
void	authorise(curam.commonintake.authorisation.facade.struct.AuthorisationDetails key) Invokes the authorization process for the selected program.
void	denyProgram(curam.commonintake.authorisation.facade.struct.DenyProgramDetails dtls) Denies the program application for the selected program.
curam.commonintake.authorisation.facade.struct.AuthorisationDisplayDetails	getAuthorisationDisplayDetails(curam.commonintake.facade.struct.ApplicationCaseKey caseKey, curam.commonintake.authorisation.facade.struct.ProgramKey programKey) Retrieves the authorization modal window details.
curam.commonintake.authorisation.facade.struct.ProgramAuthorisationData	listAuthorisationDetails(curam.commonintake.authorisation.facade.struct.ProgramAuthorisationDataKey programAuthorisationDataKey) Retrieves program authorisation details.
curam.commonintake.authorisation.facade.struct.AuthorisationEvidenceDetailsList	listAuthorisationEvidence(curam.commonintake.authorisation.facade.struct.ProgramAuthorisationDataKey key) Retrieves a list of evidence used during a particular authorization event.
curam.commonintake.authorisation.facade.struct.ProgramAuthorisationDetailsList	listAuthorisations(curam.commonintake.authorisation.facade.struct.ProgramKey key) Retrieves a list of authorizations for the program application.
curam.commonintake.authorisation.facade.struct.AuthorisationExistingCasesList	listClientsExistingCases(curam.commonintake.entity.struct.ApplicationCaseKey caseKey, curam.workspaceservices.intake.struct.IntakeProgramApplicationKey key) Retrieves a list of active integrated cases for the clients on the application case.
curam.commonintake.authorisation.facade.struct.ListClientSelectionResult	listClientsForSelection(curam.commonintake.entity.struct.ApplicationCaseKey key) Retrieves a list of active case members for selection during program authorization.
curam.commonintake.authorisation.facade.struct.ProgramDenialDetailsList	listProgramDenials(curam.workspaceservices.intake.struct.IntakeProgramApplicationKey key) Retrieves a list of program denials for the intake program application.
curam.commonintake.authorisation.facade.struct.ProgramWithdrawalList	listProgramWithdrawals(curam.workspaceservices.intake.struct.IntakeProgramApplicationKey key) Retrieves a list of withdrawals for the intake program application.
void	modifyProgramDenial(curam.commonintake.authorisation.entity.struct.ProgramDenialDtls dtls) Modifies the program denial record.
void	modifyProgramOnlineWithdrawal(curam.commonintake.authorisation.facade.struct.ProgramWithdrawalDetails details) Modifies the withdrawal request record when the withdrawal has been made online.
void	modifyProgramWithdrawal(curam.commonintake.authorisation.facade.struct.ProgramWithdrawalDetails details) Modifies the withdrawal request record.
curam.commonintake.authorisation.facade.struct.Comments	readAuthorisationComments(curam.commonintake.authorisation.facade.struct.ProgramAuthorisationDataKey key) Retrieves the comments for the specified program authorization.
curam.commonintake.authorisation.facade.struct.Comments	readProgramDenialComments(curam.commonintake.authorisation.entity.struct.ProgramDenialKey key) Retrieves the comments for the specified program denial.
curam.commonintake.authorisation.entity.struct.ProgramDenialDtls	readProgramDenialDetails(curam.commonintake.authorisation.entity.struct.ProgramDenialKey key) Retrieves the denial details for the specified program denial.
curam.commonintake.authorisation.facade.struct.ProgramWithdrawalReadDetails	readWithdrawalDetails(curam.workspaceservices.intake.struct.WithdrawalRequestKey key) Retrieves the withdrawal details for the specified withdrawal request.
curam.commonintake.authorisation.facade.struct.ProgramWithdrawalClientsAndRequestMethodList	readWithdrawalProgramClientsAndRequestMethod(curam.workspaceservices.intake.struct.IntakeProgramApplicationKey key) Retrieves the intake program type and the clients on the application for display on the client.
void	withdrawProgram(curam.commonintake.authorisation.facade.struct.ProgramWithdrawalDetails details) Withdraws the intake program application for the selected program.

Method Detail

listClientsExistingCases

curam.commonintake.authorisation.facade.struct.AuthorisationExistingCasesList listClientsExistingCases(curam.commonintake.entity.struct.ApplicationCaseKey caseKey,
                                                                                                       curam.workspaceservices.intake.struct.IntakeProgramApplicationKey key)
                                                                                                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.

key - The intake program application identifier.

Returns:

A list of all existing integrated cases for the clients.

Throws:

curam.util.exception.AppException - Generic Exception.

curam.util.exception.InformationalException - Generic Exception.

listAuthorisationDetails

curam.commonintake.authorisation.facade.struct.ProgramAuthorisationData listAuthorisationDetails(curam.commonintake.authorisation.facade.struct.ProgramAuthorisationDataKey programAuthorisationDataKey)
                                                                                          throws curam.util.exception.AppException,
                                                                                                 curam.util.exception.InformationalException

Retrieves program authorisation details.

Parameters:

key - The unique identifier of the program authorization data created as part of the authorization event.

Returns:

details for a particular authorization event.

Throws:

curam.util.exception.AppException - Generic Exception.

curam.util.exception.InformationalException - Generic Exception.

getAuthorisationDisplayDetails

curam.commonintake.authorisation.facade.struct.AuthorisationDisplayDetails getAuthorisationDisplayDetails(curam.commonintake.facade.struct.ApplicationCaseKey caseKey,
                                                                                                          curam.commonintake.authorisation.facade.struct.ProgramKey programKey)
                                                                                                   throws curam.util.exception.AppException,
                                                                                                          curam.util.exception.InformationalException

Retrieves the authorization modal window details.

Parameters:

caseKey - The application case identifier.

programKey - The intake program application case identifier.

Returns:

Authorization modal window details.

Throws:

curam.util.exception.AppException - Generic Exception.

curam.util.exception.InformationalException - Generic Exception.

authorise

void authorise(curam.commonintake.authorisation.facade.struct.AuthorisationDetails key)
        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.

listAuthorisations

curam.commonintake.authorisation.facade.struct.ProgramAuthorisationDetailsList listAuthorisations(curam.commonintake.authorisation.facade.struct.ProgramKey key)
                                                                                           throws curam.util.exception.AppException,
                                                                                                  curam.util.exception.InformationalException

Retrieves a list of authorizations for the program application.

Parameters:

key - The unqiue identifier of the intake program application.

Returns:

A list of authorizations for the program application.

Throws:

curam.util.exception.AppException - Generic Exception.

curam.util.exception.InformationalException - Generic Exception.

listAuthorisationEvidence

curam.commonintake.authorisation.facade.struct.AuthorisationEvidenceDetailsList listAuthorisationEvidence(curam.commonintake.authorisation.facade.struct.ProgramAuthorisationDataKey key)
                                                                                                   throws curam.util.exception.AppException,
                                                                                                          curam.util.exception.InformationalException

Retrieves a list of evidence used during a particular authorization event.

Parameters:

key - The unique identifier of the program authorization data created as part of the authorization event for which the evidence is being sought.

Returns:

A list of evidence used during a particular authorization event.

Throws:

curam.util.exception.AppException - Generic Exception.

curam.util.exception.InformationalException - Generic Exception.

readAuthorisationComments

curam.commonintake.authorisation.facade.struct.Comments readAuthorisationComments(curam.commonintake.authorisation.facade.struct.ProgramAuthorisationDataKey key)
                                                                           throws curam.util.exception.AppException,
                                                                                  curam.util.exception.InformationalException

Retrieves the comments for the specified program authorization.

Parameters:

key - The unique identifier of the data associated to the authorization event.

Returns:

The comments for the specified program authorization.

Throws:

curam.util.exception.AppException - Generic Exception.

curam.util.exception.InformationalException - Generic Exception.

denyProgram

void denyProgram(curam.commonintake.authorisation.facade.struct.DenyProgramDetails dtls)
          throws curam.util.exception.AppException,
                 curam.util.exception.InformationalException

Denies the program application for the selected program.

Parameters:

dtls - The details of the denial passed in from the client.

Throws:

curam.util.exception.AppException - Generic Exception.

curam.util.exception.InformationalException - Generic Exception.

readProgramDenialDetails

curam.commonintake.authorisation.entity.struct.ProgramDenialDtls readProgramDenialDetails(curam.commonintake.authorisation.entity.struct.ProgramDenialKey key)
                                                                                   throws curam.util.exception.AppException,
                                                                                          curam.util.exception.InformationalException

Retrieves the denial details for the specified program denial.

Parameters:

key - The unique identifier of the program denial record.

Returns:

The details for the program denial.

Throws:

curam.util.exception.AppException - Generic Exception.

curam.util.exception.InformationalException - Generic Exception.

modifyProgramDenial

void modifyProgramDenial(curam.commonintake.authorisation.entity.struct.ProgramDenialDtls dtls)
                  throws curam.util.exception.AppException,
                         curam.util.exception.InformationalException

Modifies the program denial record.

Parameters:

dtls - The details of the denial passed in from the client.

Throws:

curam.util.exception.AppException - Generic Exception.

curam.util.exception.InformationalException - Generic Exception.

readProgramDenialComments

curam.commonintake.authorisation.facade.struct.Comments readProgramDenialComments(curam.commonintake.authorisation.entity.struct.ProgramDenialKey key)
                                                                           throws curam.util.exception.AppException,
                                                                                  curam.util.exception.InformationalException

Retrieves the comments for the specified program denial.

Parameters:

key - The unique identifier of the program denial record.

Returns:

The comments for the specified program denial.

Throws:

curam.util.exception.AppException - Generic Exception.

curam.util.exception.InformationalException - Generic Exception.

listProgramDenials

curam.commonintake.authorisation.facade.struct.ProgramDenialDetailsList listProgramDenials(curam.workspaceservices.intake.struct.IntakeProgramApplicationKey key)
                                                                                    throws curam.util.exception.AppException,
                                                                                           curam.util.exception.InformationalException

Retrieves a list of program denials for the intake program application.

Parameters:

key - The unqiue identifier of the intake program application.

Returns:

A list of program denials for the intake program application.

Throws:

curam.util.exception.AppException - Generic Exception.

curam.util.exception.InformationalException - Generic Exception.

withdrawProgram

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

Withdraws the intake program application for the selected program.

Parameters:

details - The details of the withdrawal passed in from the client.

Throws:

curam.util.exception.AppException - Generic Exception.

curam.util.exception.InformationalException - Generic Exception.

listProgramWithdrawals

curam.commonintake.authorisation.facade.struct.ProgramWithdrawalList listProgramWithdrawals(curam.workspaceservices.intake.struct.IntakeProgramApplicationKey key)
                                                                                     throws curam.util.exception.AppException,
                                                                                            curam.util.exception.InformationalException

Retrieves a list of withdrawals for the intake program application.

Parameters:

key - The unqiue identifier of the intake program application.

Returns:

A list of programs which have been withdrawn.

Throws:

curam.util.exception.AppException - Generic Exception.

curam.util.exception.InformationalException - Generic Exception.

readWithdrawalDetails

curam.commonintake.authorisation.facade.struct.ProgramWithdrawalReadDetails readWithdrawalDetails(curam.workspaceservices.intake.struct.WithdrawalRequestKey key)
                                                                                           throws curam.util.exception.AppException,
                                                                                                  curam.util.exception.InformationalException

Retrieves the withdrawal details for the specified withdrawal request.

Parameters:

key - The unique identifier of the withdrawal request record.

Returns:

The details for the specified withdrawal request.

Throws:

curam.util.exception.AppException - Generic Exception.

curam.util.exception.InformationalException - Generic Exception.

readWithdrawalProgramClientsAndRequestMethod

curam.commonintake.authorisation.facade.struct.ProgramWithdrawalClientsAndRequestMethodList readWithdrawalProgramClientsAndRequestMethod(curam.workspaceservices.intake.struct.IntakeProgramApplicationKey key)
                                                                                                                                  throws curam.util.exception.AppException,
                                                                                                                                         curam.util.exception.InformationalException

Retrieves the intake program type and the clients on the application for display on the client.

Parameters:

key - The unique identifier of the intake program application.

Returns:

The intake program and the application clients.

Throws:

curam.util.exception.AppException - Generic Exception.

curam.util.exception.InformationalException - Generic Exception.

modifyProgramWithdrawal

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

Modifies the withdrawal request record.

Parameters:

details - The details of the withdrawal passed in from the client.

Throws:

curam.util.exception.AppException - Generic Exception.

curam.util.exception.InformationalException - Generic Exception.

modifyProgramOnlineWithdrawal

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

Modifies the withdrawal request record when the withdrawal has been made online.

Parameters:

details - The details of the withdrawal passed in from the client.

Throws:

curam.util.exception.AppException - Generic Exception.

curam.util.exception.InformationalException - Generic Exception.

listClientsForSelection

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

Retrieves a list of active case members for selection during program authorization.

Parameters:

key - An application case entity key.

Returns:

A list of clients for selection.

Throws:

curam.util.exception.AppException - Generic Exception.

curam.util.exception.InformationalException - Generic Exception.