curam.contextviewer.configuration.casehandler.impl

Interface IContextCaseHandler

All Known Implementing Classes:

ContextCaseHandler

@AccessLevel(value=EXTERNAL)
public interface IContextCaseHandler

Interface for the context case handler. This interface provides methods that are called by the CCV to determine different configuration settings for a case type.

Method Summary

Modifier and Type	Method and Description
boolean	checkCaseParticipantRole(java.lang.String caseParticipantRole) This method checks if the CCV client has an acceptable case participant role on the case in question.
boolean	checkCaseStatus(java.lang.String caseStatus) This method checks if the case in question is of an acceptable status, based on the status configurations for that case type.
boolean	checkType(java.lang.String caseID) This method checks if the case in question is of an acceptable type, based on the configurations for that case type.
boolean	displayCase(java.lang.String caseStatus, java.lang.String caseID, java.lang.String caseParticipantRole) Parent method called by CCV to determine if a case is eligible for display.
java.lang.String	getCaseName(java.lang.String caseID) Retrieves the case name for a given case type / case.
java.lang.String	getShowAllCaseParticipantRoles() Retrieves a configuration property that denotes if cases where the claimant is of any case participant role is to be displayed.

Method Detail

displayCase

boolean displayCase(java.lang.String caseStatus,
                    java.lang.String caseID,
                    java.lang.String caseParticipantRole)
             throws curam.util.exception.AppException,
                    curam.util.exception.InformationalException

Parent method called by CCV to determine if a case is eligible for display.

Parameters:

caseStatus - The status of the case

caseID - The ID of the case

caseParticipantRole - The case participant role

Returns:

returns true of case is to be displayed

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

checkCaseStatus

boolean checkCaseStatus(java.lang.String caseStatus)

This method checks if the case in question is of an acceptable status, based on the status configurations for that case type.

Parameters:

caseStatus - The status of the case

Returns:

Returns true if case is of an acceptable status

checkType

boolean checkType(java.lang.String caseID)
           throws curam.util.exception.AppException,
                  curam.util.exception.InformationalException

This method checks if the case in question is of an acceptable type, based on the configurations for that case type.

Parameters:

caseID - The ID of the case

Returns:

Returns true if case is of an acceptable status

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

checkCaseParticipantRole

boolean checkCaseParticipantRole(java.lang.String caseParticipantRole)

This method checks if the CCV client has an acceptable case participant role on the case in question.

Parameters:

caseParticipantRole - CCV clients case participant role

Returns:

Returns true if CCV clients case participant role is of an acceptable status

getCaseName

java.lang.String getCaseName(java.lang.String caseID)
                      throws curam.util.exception.AppException,
                             curam.util.exception.InformationalException

Retrieves the case name for a given case type / case.

Parameters:

caseID - The ID of the case

Returns:

case name

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

getShowAllCaseParticipantRoles

java.lang.String getShowAllCaseParticipantRoles()

Retrieves a configuration property that denotes if cases where the claimant is of any case participant role is to be displayed. If set to false, a list of acceptable case participant role types should be set.

Returns:

List of acceptable case statuses