curam.sanctionassessment.facade.intf

Interface SanctionAssessment

All Known Implementing Classes:

SanctionAssessment, curam.sanctionassessment.facade.impl.SanctionAssessment, SanctionAssessmentFactory

@AccessLevel(value=EXTERNAL)
public interface SanctionAssessment

This business interface provides operations related to sanction assessment.

Method Summary

Modifier and Type	Method and Description
void	cancelSanction(curam.isproduct.facade.struct.SanctionKey key) Cancels the sanction assessment.
void	cancelSanctionOverride(curam.isproduct.facade.struct.SanctionOverrideKey key) Cancels the sanction override.
void	createSanction(curam.isproduct.facade.struct.ISPSanctionAssessmentProcKey key, curam.isproduct.facade.struct.SanctionDetails dtls) Creates the sanction.
void	createSanctionOrSanctionOverride(curam.isproduct.facade.struct.ISPSanctionAssessmentProcKey key, curam.isproduct.facade.struct.SanctionOrSanctionOverrideDetails dtls) Creates either sanction or sanction override records for an assessment.
void	createSanctionOverride(curam.isproduct.facade.struct.ISPSanctionAssessmentProcKey key, curam.isproduct.facade.struct.SanctionOverrideDetails dtls) Creates the sanction override.
curam.isproduct.facade.struct.SanctionResultsDetailsList	listSanctionAssessmentResultDetails(curam.isproduct.facade.struct.SanctionResultKey key) Reads a list of results of the sanction assessment.
curam.isproduct.sl.struct.SanctionDetailsList	listSanctionForCase(curam.isproduct.sl.entity.struct.SearchByCaseIDKey key) Reads the details of the sanction for a case.
curam.isproduct.sl.struct.SanctionOverrideListDetailsList	listSanctionOverrideForCase(curam.isproduct.sl.entity.struct.SearchByCaseIDKey key) Reads the details of the sanction override for a case.
curam.isproduct.facade.struct.SanctionRecommendationDetailsList	listSanctionRecommendations(curam.isproduct.sl.struct.ISPCaseIDKey integratedCaseID) Reads the details of the sanction recommendation for a case.
void	modifySanction(curam.isproduct.facade.struct.SanctionDetails dtls) Modifies the details of the sanction.
void	modifySanctionOverride(curam.isproduct.facade.struct.SanctionOverrideDetails dtls) Modifies the details of the sanction override.
curam.isproduct.facade.struct.SanctionAndParticipantNameDetails	readSanctionByAssessmentID(curam.isproduct.facade.struct.ISPSanctionAssessmentProcKey key) Reads the details of the sanction for an assessment.
curam.isproduct.facade.struct.SanctionOverrideAndParticipantNameDetails	readSanctionOverrideByAssessmentID(curam.isproduct.facade.struct.ISPSanctionAssessmentProcKey key) Reads the details of a sanction override for an assessment.
curam.isproduct.facade.struct.SanctionRecommendationDetails	readSanctionRecommendation(curam.isproduct.sl.entity.struct.SanctionRecommendationKey key) Reads the details of the sanction recommendation record based on an identifier of the sanction recommendation.
curam.isproduct.facade.struct.SanctionAssesmentStatusValue	resolveResults(curam.isproduct.facade.struct.SactionAssessmentStatusCode key) Reads the sanction assessment status value for the sanction assessment status code.
void	validateAndCloseSanctionAssessmentTask(curam.isproduct.facade.struct.SanctionTaskKey key) Validates whether the sanctions are in action and if not, closes the task associated with a sanction assessment.

Method Detail

listSanctionAssessmentResultDetails

@AccessLevel(value=EXTERNAL)
curam.isproduct.facade.struct.SanctionResultsDetailsList listSanctionAssessmentResultDetails(curam.isproduct.facade.struct.SanctionResultKey key)
                                                                                                                   throws curam.util.exception.AppException,
                                                                                                                          curam.util.exception.InformationalException

Reads a list of results of the sanction assessment.

Parameters:

key - Identifier of the case decision set and the case.

Returns:

A list of sanction assessment results.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

ConcernRole, CaseParticipantRole, CaseDecisionObjective

readSanctionOverrideByAssessmentID

@AccessLevel(value=EXTERNAL)
curam.isproduct.facade.struct.SanctionOverrideAndParticipantNameDetails readSanctionOverrideByAssessmentID(curam.isproduct.facade.struct.ISPSanctionAssessmentProcKey key)
                                                                                                                                 throws curam.util.exception.AppException,
                                                                                                                                        curam.util.exception.InformationalException

Reads the details of a sanction override for an assessment.

Parameters:

key - Identifier of the sanction assessment.

Returns:

The list of sanction assessment results.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

SanctionOverride

createSanctionOrSanctionOverride

@AccessLevel(value=EXTERNAL)
void createSanctionOrSanctionOverride(curam.isproduct.facade.struct.ISPSanctionAssessmentProcKey key,
                                                                   curam.isproduct.facade.struct.SanctionOrSanctionOverrideDetails dtls)
                                                            throws curam.util.exception.AppException,
                                                                   curam.util.exception.InformationalException

Creates either sanction or sanction override records for an assessment.

Parameters:

key - Identifier of the income support product sanction assessment process.

dtls - The details of the sanction override.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

SanctionOverride, Sanction

Business Object Write:

SanctionOverride, Sanction

cancelSanctionOverride

@AccessLevel(value=EXTERNAL)
void cancelSanctionOverride(curam.isproduct.facade.struct.SanctionOverrideKey key)
                                                  throws curam.util.exception.AppException,
                                                         curam.util.exception.InformationalException

Cancels the sanction override.
The system further modifies the status of the income support product sanction assessment process.

Parameters:

key - Identifier of the sanction override.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

SanctionOverride

Business Object Write:

SanctionOverride

modifySanction

@AccessLevel(value=EXTERNAL)
void modifySanction(curam.isproduct.facade.struct.SanctionDetails dtls)
                                          throws curam.util.exception.AppException,
                                                 curam.util.exception.InformationalException

Modifies the details of the sanction.

Parameters:

details - The details of the sanction.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Sanction

Business Object Write:

Sanction

cancelSanction

@AccessLevel(value=EXTERNAL)
void cancelSanction(curam.isproduct.facade.struct.SanctionKey key)
                                          throws curam.util.exception.AppException,
                                                 curam.util.exception.InformationalException

Cancels the sanction assessment.
The system further modifies the status of the income support product sanction assessment process.

Parameters:

key - Identifier of the sanction.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Sanction

Business Object Write:

Sanction

readSanctionByAssessmentID

@AccessLevel(value=EXTERNAL)
curam.isproduct.facade.struct.SanctionAndParticipantNameDetails readSanctionByAssessmentID(curam.isproduct.facade.struct.ISPSanctionAssessmentProcKey key)
                                                                                                                 throws curam.util.exception.AppException,
                                                                                                                        curam.util.exception.InformationalException

Reads the details of the sanction for an assessment.

Parameters:

key - Identifier of the income support product sanction assessment process.

Returns:

The details of the sanction.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Sanction

modifySanctionOverride

@AccessLevel(value=EXTERNAL)
void modifySanctionOverride(curam.isproduct.facade.struct.SanctionOverrideDetails dtls)
                                                  throws curam.util.exception.AppException,
                                                         curam.util.exception.InformationalException

Modifies the details of the sanction override.

Parameters:

details - The details of the sanction override.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

SanctionOverride

Business Object Write:

SanctionOverride

validateAndCloseSanctionAssessmentTask

@AccessLevel(value=EXTERNAL)
void validateAndCloseSanctionAssessmentTask(curam.isproduct.facade.struct.SanctionTaskKey key)
                                                                  throws curam.util.exception.AppException,
                                                                         curam.util.exception.InformationalException

Validates whether the sanctions are in action and if not, closes the task associated with a sanction assessment.

Parameters:

key - Identifier of the task.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Sanction

resolveResults

@AccessLevel(value=EXTERNAL)
curam.isproduct.facade.struct.SanctionAssesmentStatusValue resolveResults(curam.isproduct.facade.struct.SactionAssessmentStatusCode key)
                                                                                                throws curam.util.exception.AppException,
                                                                                                       curam.util.exception.InformationalException

Reads the sanction assessment status value for the sanction assessment status code. The value will be used to resolve the display pages.

Parameters:

sactionAssessmentStatusCode - A sanction assessment status code table code.

Returns:

The sanction assessment status value.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

createSanction

@AccessLevel(value=EXTERNAL)
void createSanction(curam.isproduct.facade.struct.ISPSanctionAssessmentProcKey key,
                                                 curam.isproduct.facade.struct.SanctionDetails dtls)
                                          throws curam.util.exception.AppException,
                                                 curam.util.exception.InformationalException

Creates the sanction.

Parameters:

dtls - The details of the sanction.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Sanction

Business Object Write:

Sanction

createSanctionOverride

@AccessLevel(value=EXTERNAL)
void createSanctionOverride(curam.isproduct.facade.struct.ISPSanctionAssessmentProcKey key,
                                                         curam.isproduct.facade.struct.SanctionOverrideDetails dtls)
                                                  throws curam.util.exception.AppException,
                                                         curam.util.exception.InformationalException

Creates the sanction override.

Parameters:

dtls - The details of the sanction override.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

SanctionOverride

Business Object Write:

SanctionOverride

listSanctionForCase

@AccessLevel(value=EXTERNAL)
curam.isproduct.sl.struct.SanctionDetailsList listSanctionForCase(curam.isproduct.sl.entity.struct.SearchByCaseIDKey key)
                                                                                        throws curam.util.exception.AppException,
                                                                                               curam.util.exception.InformationalException

Reads the details of the sanction for a case.

Parameters:

key - Identifier of the case.

Returns:

A list of details of the sanction.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Sanction, ConcernRole

listSanctionOverrideForCase

@AccessLevel(value=EXTERNAL)
curam.isproduct.sl.struct.SanctionOverrideListDetailsList listSanctionOverrideForCase(curam.isproduct.sl.entity.struct.SearchByCaseIDKey key)
                                                                                                            throws curam.util.exception.AppException,
                                                                                                                   curam.util.exception.InformationalException

Reads the details of the sanction override for a case.

Parameters:

key - Identifier of the case.

Returns:

A list of details of the sanction override.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

SanctionOverride, ConcernRole

listSanctionRecommendations

@AccessLevel(value=EXTERNAL)
curam.isproduct.facade.struct.SanctionRecommendationDetailsList listSanctionRecommendations(curam.isproduct.sl.struct.ISPCaseIDKey integratedCaseID)
                                                                                                                  throws curam.util.exception.AppException,
                                                                                                                         curam.util.exception.InformationalException

Reads the details of the sanction recommendation for a case.

Parameters:

ispCaseIDKey - Identifier of the case.

Returns:

A list of details of the sanction recommendation.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

SanctionRecommendation, Sanction, SanctionOverride, ConcernRole

readSanctionRecommendation

@AccessLevel(value=EXTERNAL)
curam.isproduct.facade.struct.SanctionRecommendationDetails readSanctionRecommendation(curam.isproduct.sl.entity.struct.SanctionRecommendationKey key)
                                                                                                             throws curam.util.exception.AppException,
                                                                                                                    curam.util.exception.InformationalException

Reads the details of the sanction recommendation record based on an identifier of the sanction recommendation.

Parameters:

sanctionRecommendationKey - Identifier of the sanction recommendation.

Returns:

The details of the sanction recommendation.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

SanctionRecommendation, ConcernRole