curam.cpm.facade.intf

Interface ProviderInvestigation

All Known Implementing Classes:

ProviderInvestigation, curam.cpm.facade.impl.ProviderInvestigation, ProviderInvestigationFactory

@AccessLevel(value=EXTERNAL)
public interface ProviderInvestigation

This business interface is used for managing the functionality relating to a provider investigation. An investigation is an inquiry into circumstances surrounding an allegation or incident. If a provider or a person associated with the provider is suspected of wrongdoing, it is in the organization's interest to investigate such matters and resolve them as quickly and efficiently as possible.

Method Summary

Modifier and Type	Method and Description
curam.core.sl.entity.struct.InvestigationDeliveryKey	createProviderInvestigation(curam.core.sl.struct.InvestigationCreationDetails details) Creates an investigation delivery case for a given provider.
curam.cpm.facade.struct.ProviderInvestigationDeliveryActionPlanList	listInvestigationDeliveryActionPlan(curam.core.sl.entity.struct.LinkKey key) Returns the list of action plans on an investigation delivery case.
curam.cpm.facade.struct.ProviderInvestigationDeliveryAllegationList	listInvestigationDeliveryAllegation(curam.core.struct.CaseHeaderKey key) Returns the list of allegations on an investigation delivery case for a provider.
curam.cpm.facade.struct.ProviderInvestigationDeliveryAttachmentList	listInvestigationDeliveryAttachment(curam.core.struct.CaseHeaderKey key) Returns the list of attachments on an investigation delivery case for a provider.
curam.cpm.facade.struct.ProviderInvestigationDeliveryClientRoleList	listInvestigationDeliveryCaseMember(curam.core.struct.CaseHeaderKey key) Returns the list of case members on an investigation delivery case for a provider.
curam.cpm.facade.struct.ProviderInvestigationDeliveryClientRoleList	listInvestigationDeliveryClientRole(curam.core.struct.CaseHeaderKey key) Returns the list of client roles on an investigation delivery case for a provider.
curam.cpm.facade.struct.ProviderInvestigationDeliveryCommunicationList	listInvestigationDeliveryCommunication(curam.core.struct.CaseHeaderKey key) Returns the list of communications on an investigation delivery case for a provider.
curam.cpm.facade.struct.ProviderInvestigationDeliveryContactLogList	listInvestigationDeliveryContactLog(curam.core.struct.CaseHeaderKey key) Returns the list of contact logs on an investigation delivery case for a provider.
curam.cpm.facade.struct.ProviderInvestigationDeliveryEventList	listInvestigationDeliveryEvent(curam.core.struct.CaseHeaderKey key) Returns the list of events on an investigation delivery case for a provider.
curam.cpm.facade.struct.ProviderInvestigationDeliveryMilestoneList	listInvestigationDeliveryMilestone(curam.core.struct.CaseHeaderKey key) Returns the list of milestones on an investigation delivery case for a provider.
curam.cpm.facade.struct.ProviderInvestigationDeliveryNoteList	listInvestigationDeliveryNote(curam.core.struct.CaseHeaderKey key) Returns the list of notes on an investigation delivery case for a provider.
curam.cpm.facade.struct.ProviderInvestigationDeliveryRelatedCaseList	listInvestigationDeliveryRelatedCase(curam.core.struct.CaseHeaderKey key) Returns the list of cases related to an investigation delivery case for a provider.
curam.cpm.facade.struct.ProviderInvestigationDeliveryTaskList	listInvestigationDeliveryTask(curam.core.struct.CaseHeaderKey key) Returns the list of tasks on an investigation delivery case for a provider.
curam.cpm.facade.struct.ProviderInvestigationDeliveryUserRoleList	listInvestigationDeliveryUserRole(curam.core.struct.CaseHeaderKey key) Returns the list of user roles on an investigation delivery case for a provider.
curam.cpm.facade.struct.InvestigationDeliveryListForProvider	listInvestigationsForProvider(curam.cpm.sl.entity.struct.ProviderConcernRoleKey key) Returns the list of investigations for a provider where the provider plays a direct role (or) plays a role in an allegation associated with an investigation.
curam.cpm.facade.struct.ProviderInvestigationDeliveryMilestoneList	listInvestigationUncompletedMilestone(curam.core.struct.CaseHeaderKey key) Returns the list of milestones of status 'In progress' and 'Not started' of an investigation delivery case on a provider.
curam.cpm.facade.struct.ProviderInvestigationDeliveryList	listProviderInvestigations(curam.cpm.sl.entity.struct.ProviderConcernRoleKey key) Returns the list of investigations for a given provider where the provider plays a direct role in the investigation.
curam.cpm.facade.struct.ProviderInvestigationHomeDtls	readProviderInvestigationHomeDetails(curam.core.sl.entity.struct.InvestigationDeliveryKey key) Reads the provider investigation details.

Method Detail

listProviderInvestigations

@AccessLevel(value=EXTERNAL)
curam.cpm.facade.struct.ProviderInvestigationDeliveryList listProviderInvestigations(curam.cpm.sl.entity.struct.ProviderConcernRoleKey key)
                                                                                                           throws curam.util.exception.AppException,
                                                                                                                  curam.util.exception.InformationalException

Returns the list of investigations for a given provider where the provider plays a direct role in the investigation.

Parameters:

key - The key of the Provider.

Returns:

The list of investigations for the given provider.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Investigation, Provider

createProviderInvestigation

@AccessLevel(value=EXTERNAL)
curam.core.sl.entity.struct.InvestigationDeliveryKey createProviderInvestigation(curam.core.sl.struct.InvestigationCreationDetails details)
                                                                                                       throws curam.util.exception.AppException,
                                                                                                              curam.util.exception.InformationalException

Creates an investigation delivery case for a given provider.

Parameters:

details - The details of the investigation.

Returns:

The key of the newly created investigation delivery case.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

Investigation

readProviderInvestigationHomeDetails

@AccessLevel(value=EXTERNAL)
curam.cpm.facade.struct.ProviderInvestigationHomeDtls readProviderInvestigationHomeDetails(curam.core.sl.entity.struct.InvestigationDeliveryKey key)
                                                                                                                 throws curam.util.exception.AppException,
                                                                                                                        curam.util.exception.InformationalException

Reads the provider investigation details.

Parameters:

key - The key of the investigation delivery case.

Returns:

The details of the investigation delivery case.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Investigation

listInvestigationDeliveryActionPlan

@AccessLevel(value=EXTERNAL)
curam.cpm.facade.struct.ProviderInvestigationDeliveryActionPlanList listInvestigationDeliveryActionPlan(curam.core.sl.entity.struct.LinkKey key)
                                                                                                                              throws curam.util.exception.AppException,
                                                                                                                                     curam.util.exception.InformationalException

Returns the list of action plans on an investigation delivery case.

Parameters:

key - The key of the investigation delivery case.

Returns:

The list of action plans on the investigation delivery case.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Investigation, ActionPlan

listInvestigationDeliveryAllegation

@AccessLevel(value=EXTERNAL)
curam.cpm.facade.struct.ProviderInvestigationDeliveryAllegationList listInvestigationDeliveryAllegation(curam.core.struct.CaseHeaderKey key)
                                                                                                                              throws curam.util.exception.AppException,
                                                                                                                                     curam.util.exception.InformationalException

Returns the list of allegations on an investigation delivery case for a provider.

Parameters:

key - The key of the investigation delivery case.

Returns:

The list of allegations of the investigation delivery case.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Investigation, Allegation

listInvestigationDeliveryAttachment

@AccessLevel(value=EXTERNAL)
curam.cpm.facade.struct.ProviderInvestigationDeliveryAttachmentList listInvestigationDeliveryAttachment(curam.core.struct.CaseHeaderKey key)
                                                                                                                              throws curam.util.exception.AppException,
                                                                                                                                     curam.util.exception.InformationalException

Returns the list of attachments on an investigation delivery case for a provider.

Parameters:

key - The key of the investigation delivery case.

Returns:

The list of attachments on the investigation delivery case.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Investigation, Attachment

listInvestigationDeliveryCaseMember

@AccessLevel(value=EXTERNAL)
curam.cpm.facade.struct.ProviderInvestigationDeliveryClientRoleList listInvestigationDeliveryCaseMember(curam.core.struct.CaseHeaderKey key)
                                                                                                                              throws curam.util.exception.AppException,
                                                                                                                                     curam.util.exception.InformationalException

Returns the list of case members on an investigation delivery case for a provider.

Parameters:

key - The key of the investigation delivery case.

Returns:

The list of case members of the investigation delivery case.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Investigation, CaseParticipant

listInvestigationDeliveryClientRole

@AccessLevel(value=EXTERNAL)
curam.cpm.facade.struct.ProviderInvestigationDeliveryClientRoleList listInvestigationDeliveryClientRole(curam.core.struct.CaseHeaderKey key)
                                                                                                                              throws curam.util.exception.AppException,
                                                                                                                                     curam.util.exception.InformationalException

Returns the list of client roles on an investigation delivery case for a provider.

Parameters:

key - The key of the investigation delivery case.

Returns:

The list of client role details on the investigation delivery case.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Investigation

listInvestigationDeliveryCommunication

@AccessLevel(value=EXTERNAL)
curam.cpm.facade.struct.ProviderInvestigationDeliveryCommunicationList listInvestigationDeliveryCommunication(curam.core.struct.CaseHeaderKey key)
                                                                                                                                    throws curam.util.exception.AppException,
                                                                                                                                           curam.util.exception.InformationalException

Returns the list of communications on an investigation delivery case for a provider.

Parameters:

key - The key of the investigation delivery case.

Returns:

The list of communications details on the investigation delivery case.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Investigation, Communication

listInvestigationDeliveryContactLog

@AccessLevel(value=EXTERNAL)
curam.cpm.facade.struct.ProviderInvestigationDeliveryContactLogList listInvestigationDeliveryContactLog(curam.core.struct.CaseHeaderKey key)
                                                                                                                              throws curam.util.exception.AppException,
                                                                                                                                     curam.util.exception.InformationalException

Returns the list of contact logs on an investigation delivery case for a provider.

Parameters:

key - The key of the investigation delivery case.

Returns:

The list of contact logs of the investigation delivery case.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Investigation, ContactLog

listInvestigationDeliveryEvent

@AccessLevel(value=EXTERNAL)
curam.cpm.facade.struct.ProviderInvestigationDeliveryEventList listInvestigationDeliveryEvent(curam.core.struct.CaseHeaderKey key)
                                                                                                                    throws curam.util.exception.AppException,
                                                                                                                           curam.util.exception.InformationalException

Returns the list of events on an investigation delivery case for a provider.

Parameters:

key - The key of the investigation delivery case.

Returns:

The list of events on the investigation delivery case.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Investigation, CaseEvent, Activity

listInvestigationDeliveryMilestone

@AccessLevel(value=EXTERNAL)
curam.cpm.facade.struct.ProviderInvestigationDeliveryMilestoneList listInvestigationDeliveryMilestone(curam.core.struct.CaseHeaderKey key)
                                                                                                                            throws curam.util.exception.AppException,
                                                                                                                                   curam.util.exception.InformationalException

Returns the list of milestones on an investigation delivery case for a provider.

Parameters:

key - The key of the investigation delivery case.

Returns:

The list of all milestones of an investigation delivery case.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Investigation, Milestone

listInvestigationDeliveryNote

@AccessLevel(value=EXTERNAL)
curam.cpm.facade.struct.ProviderInvestigationDeliveryNoteList listInvestigationDeliveryNote(curam.core.struct.CaseHeaderKey key)
                                                                                                                  throws curam.util.exception.AppException,
                                                                                                                         curam.util.exception.InformationalException

Returns the list of notes on an investigation delivery case for a provider.

Parameters:

key - The key of the investigation delivery case.

Returns:

The list of investigation delivery notes.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Investigation, Note

listInvestigationDeliveryRelatedCase

@AccessLevel(value=EXTERNAL)
curam.cpm.facade.struct.ProviderInvestigationDeliveryRelatedCaseList listInvestigationDeliveryRelatedCase(curam.core.struct.CaseHeaderKey key)
                                                                                                                                throws curam.util.exception.AppException,
                                                                                                                                       curam.util.exception.InformationalException

Returns the list of cases related to an investigation delivery case for a provider.

Parameters:

key - The key of the investigation delivery case.

Returns:

The list of related cases to an investigation delivery case.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Investigation, CaseRelationship

listInvestigationDeliveryTask

@AccessLevel(value=EXTERNAL)
curam.cpm.facade.struct.ProviderInvestigationDeliveryTaskList listInvestigationDeliveryTask(curam.core.struct.CaseHeaderKey key)
                                                                                                                  throws curam.util.exception.AppException,
                                                                                                                         curam.util.exception.InformationalException

Returns the list of tasks on an investigation delivery case for a provider.

Parameters:

key - The key of the investigation delivery case.

Returns:

The list of tasks of an investigation delivery case.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Investigation, Task

listInvestigationDeliveryUserRole

@AccessLevel(value=EXTERNAL)
curam.cpm.facade.struct.ProviderInvestigationDeliveryUserRoleList listInvestigationDeliveryUserRole(curam.core.struct.CaseHeaderKey key)
                                                                                                                          throws curam.util.exception.AppException,
                                                                                                                                 curam.util.exception.InformationalException

Returns the list of user roles on an investigation delivery case for a provider.

Parameters:

key - The key of the investigation delivery case.

Returns:

The list of user roles on an investigation delivery case.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Investigation, CaseUserRole

listInvestigationUncompletedMilestone

@AccessLevel(value=EXTERNAL)
curam.cpm.facade.struct.ProviderInvestigationDeliveryMilestoneList listInvestigationUncompletedMilestone(curam.core.struct.CaseHeaderKey key)
                                                                                                                               throws curam.util.exception.AppException,
                                                                                                                                      curam.util.exception.InformationalException

Returns the list of milestones of status 'In progress' and 'Not started' of an investigation delivery case on a provider.

Parameters:

key - The key of the investigation delivery case.

Returns:

The list of uncompleted milestones of an investigation delivery case.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Investigation, Milestone

listInvestigationsForProvider

@AccessLevel(value=EXTERNAL)
curam.cpm.facade.struct.InvestigationDeliveryListForProvider listInvestigationsForProvider(curam.cpm.sl.entity.struct.ProviderConcernRoleKey key)
                                                                                                                 throws curam.util.exception.AppException,
                                                                                                                        curam.util.exception.InformationalException

Returns the list of investigations for a provider where the provider plays a direct role (or) plays a role in an allegation associated with an investigation.

Parameters:

key - The key of the provider for whom the related investigations are to be retrieved.

Returns:

The list of investigations for a given provider.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Investigation, Provider