curam.contextviewer.configuration.casehandler.impl

Class ContextCaseHandler

java.lang.Object

curam.contextviewer.configuration.casehandler.impl.ContextCaseHandler

All Implemented Interfaces:

IContextCaseHandler, curam.contextviewer.configuration.casehandler.impl.IContextCaseHandlerProvider

@AccessLevel(value=EXTERNAL)
 @Implementable
public abstract class ContextCaseHandler
extends java.lang.Object
implements IContextCaseHandler, curam.contextviewer.configuration.casehandler.impl.IContextCaseHandlerProvider

This the parent class for all ContextCaseHandlers. Each child of this class represents a specific case type that is displayed in the CCV.

Constructor Summary

Constructors

Constructor and Description
ContextCaseHandler() Constructor.

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.
abstract java.lang.String	getCaseName(java.lang.String caseID) Retrieves the case name for a given case type / case.
IContextCaseHandler	getInstance()
abstract 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.
protected abstract java.lang.String	getShowAllStatuses() Retrieves a configuration property that denotes if cases of all statuses are to be displayed in the CCV, for a given case type.
protected abstract java.lang.String	getShowAllTypes() Retrieves a configuration property that denotes if cases of all' types' are to be displayed in the CCV, for a given case type.
protected abstract java.util.ArrayList<java.lang.String>	listAcceptableCaseParticipantRoles() Retrieves a list of acceptable case participant roles for a given case type.
protected abstract java.util.ArrayList<java.lang.String>	listAcceptableCaseStatuses() This method retrieves a list of the acceptable case statuses for a given case type.
protected abstract java.util.ArrayList<java.lang.String>	listAcceptableTypes() This method retrieves a list of the acceptable 'case types' for a given case type.
protected abstract java.lang.String	readType(java.lang.String caseID) Reads a 'case type' for a given case type.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ContextCaseHandler

public ContextCaseHandler()

Constructor.

Method Detail

displayCase

public 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.

Specified by:

displayCase in interface IContextCaseHandler

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

public 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.

Specified by:

checkCaseStatus in interface IContextCaseHandler

Parameters:

caseStatus - The status of the case

Returns:

Returns true if case is of an acceptable status

checkType

public 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.

Specified by:

checkType in interface IContextCaseHandler

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

public boolean checkCaseParticipantRole(java.lang.String caseParticipantRole)

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

Specified by:

checkCaseParticipantRole in interface IContextCaseHandler

Parameters:

caseParticipantRole - CCV clients case participant role

Returns:

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

listAcceptableCaseStatuses

protected abstract java.util.ArrayList<java.lang.String> listAcceptableCaseStatuses()

This method retrieves a list of the acceptable case statuses for a given case type.

Returns:

list of the acceptable case statuses

listAcceptableTypes

protected abstract java.util.ArrayList<java.lang.String> listAcceptableTypes()

This method retrieves a list of the acceptable 'case types' for a given case type. For example, for a ProductDelivery case type, it shall retrieve a list of all the product delivery types that are to be displayed in the CCV.

Returns:

list of the acceptable case statuses

getShowAllStatuses

protected abstract java.lang.String getShowAllStatuses()

Retrieves a configuration property that denotes if cases of all statuses are to be displayed in the CCV, for a given case type.

Returns:

List of acceptable 'case types'

getShowAllTypes

protected abstract java.lang.String getShowAllTypes()

Retrieves a configuration property that denotes if cases of all' types' are to be displayed in the CCV, for a given case type. For example, for a Product Delivery case type, it shall retrieve a property that indicates whether to display all product types (or not).

Returns:

List of acceptable case statuses

readType

protected abstract java.lang.String readType(java.lang.String caseID)
                                      throws curam.util.exception.AppException,
                                             curam.util.exception.InformationalException

Reads a 'case type' for a given case type. For example, for a ProductDelivery, this method shall return the Product Type of the case passed as an argument.

Parameters:

caseID - the case to read the type for

Returns:

'Case Type' of given case

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

getCaseName

public abstract 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.

Specified by:

getCaseName in interface IContextCaseHandler

Parameters:

caseID - The case ID

Returns:

case name

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

getShowAllCaseParticipantRoles

public abstract 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.

Specified by:

getShowAllCaseParticipantRoles in interface IContextCaseHandler

Returns:

List of acceptable case statuses

listAcceptableCaseParticipantRoles

protected abstract java.util.ArrayList<java.lang.String> listAcceptableCaseParticipantRoles()

Retrieves a list of acceptable case participant roles for a given case type.

Returns:

List of acceptable case participant roles for display in the CCV

getInstance

public IContextCaseHandler getInstance()

Specified by:

getInstance in interface curam.contextviewer.configuration.casehandler.impl.IContextCaseHandlerProvider