curam.cpm.facade.intf

Interface ProviderAccess

All Known Implementing Classes:

ProviderAccess, curam.cpm.facade.impl.ProviderAccess, ProviderAccessFactory

@AccessLevel(value=EXTERNAL)
public interface ProviderAccess

Facade class for the a cpm registered Provider. Contains facade operations for viewing details regarding a provider.

Method Summary

Modifier and Type	Method and Description
curam.cpm.facade.struct.ServiceEvaluationList	listProviderEvaluationsForService(curam.cpm.sl.entity.struct.ProviderKey providerKey, curam.cpm.facade.struct.ServiceOfferingKey serviceKey) Returns a list of evaluations recorded for the specified provider offering the specified service.
curam.cpm.facade.struct.ProviderMemberOverviewDetailsList	listProviderStaff(curam.cpm.sl.entity.struct.ProviderKey providerKey) Returns a list of member staff for the specified provider.
curam.cpm.facade.struct.ProviderBackgroundCheckSummaryDetails	viewBackgroundCheck(curam.cpm.sl.entity.struct.ProviderBackgroundCheckKey providerBackgroundCheckKey) This method retrieves all the details of the background check and displays 'active' background check failure reasons, if any exist.
curam.cpm.facade.struct.ProviderBackgroundCheckDetailsList	viewBackgroundChecksForProviderMember(curam.cpm.sl.entity.struct.ProviderPartyKey providerMemberKey) Returns a list of background checks for the specified provider member.
curam.cpm.facade.struct.ProviderViewDetails	viewProviderOverview(curam.cpm.sl.entity.struct.ProviderConcernRoleKey providerKey, curam.cpm.facade.struct.ServiceOfferingKey serviceOfferingKey) An overview of a provider, includes contact information, and details of services, service centres, accredidations and licences.
curam.cpm.facade.struct.ProviderOfferingRateDetailsList	viewProviderServiceRates(curam.cpm.sl.entity.struct.ProviderKey providerKey, curam.cpm.facade.struct.ServiceOfferingKey serviceKey) Returns a list of the rates for the specified provider and service offering.
curam.cpm.facade.struct.ServiceCriterionEvaluationSummaryList	viewServiceEvaluationOverviewForProvider(curam.cpm.sl.entity.struct.ProviderKey providerKey, curam.cpm.facade.struct.ServiceOfferingKey serviceKey) Provides an average evaluation score for each of the criterion configured for a service from a provider.

Method Detail

viewServiceEvaluationOverviewForProvider

@AccessLevel(value=EXTERNAL)
curam.cpm.facade.struct.ServiceCriterionEvaluationSummaryList viewServiceEvaluationOverviewForProvider(curam.cpm.sl.entity.struct.ProviderKey providerKey,
                                                                                                                                    curam.cpm.facade.struct.ServiceOfferingKey serviceKey)
                                                                                                                             throws curam.util.exception.AppException,
                                                                                                                                    curam.util.exception.InformationalException

Provides an average evaluation score for each of the criterion configured for a service from a provider. This method is intended to be used by users responsible for the planning and delivery of services to clients on a case.

Parameters:

serviceKey - unique identifier of the service the evaluation data is being read for

providerKey - unique identifier of the provider concern role, for which evaluations are being read

Returns:

an average evaluation score for each of the configured criterion

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

viewProviderOverview

@AccessLevel(value=EXTERNAL)
curam.cpm.facade.struct.ProviderViewDetails viewProviderOverview(curam.cpm.sl.entity.struct.ProviderConcernRoleKey providerKey,
                                                                                              curam.cpm.facade.struct.ServiceOfferingKey serviceOfferingKey)
                                                                                       throws curam.util.exception.AppException,
                                                                                              curam.util.exception.InformationalException

An overview of a provider, includes contact information, and details of services, service centres, accredidations and licences. This method is intended to be used by users responsible for the planning and delivery of services to clients on a case.

Parameters:

providerKey - unique identifier of the provider concern role

serviceOfferingKey - unique identifier of the service

Returns:

overview details of the providers, including contact details and a list of services, service centers, licenses and accredidations

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

viewBackgroundChecksForProviderMember

@AccessLevel(value=EXTERNAL)
curam.cpm.facade.struct.ProviderBackgroundCheckDetailsList viewBackgroundChecksForProviderMember(curam.cpm.sl.entity.struct.ProviderPartyKey providerMemberKey)
                                                                                                                       throws curam.util.exception.AppException,
                                                                                                                              curam.util.exception.InformationalException

Returns a list of background checks for the specified provider member. This method is intended to be used by users responsible for the planning and delivery of services to clients on a case.

Parameters:

providerMemberKey - unique identifier of the provider member list the background checks for

Returns:

list of the background checks for the specified provider member

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

viewProviderServiceRates

@AccessLevel(value=EXTERNAL)
curam.cpm.facade.struct.ProviderOfferingRateDetailsList viewProviderServiceRates(curam.cpm.sl.entity.struct.ProviderKey providerKey,
                                                                                                              curam.cpm.facade.struct.ServiceOfferingKey serviceKey)
                                                                                                       throws curam.util.exception.AppException,
                                                                                                              curam.util.exception.InformationalException

Returns a list of the rates for the specified provider and service offering. This method is intended to be used by users responsible for the planning and delivery of services to clients on a case.

Parameters:

serviceKey - unique identifier of the service

providerKey - unique identifier of the provider to get rates for

Returns:

list of the providers rates for the specified service

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

listProviderStaff

@AccessLevel(value=EXTERNAL)
curam.cpm.facade.struct.ProviderMemberOverviewDetailsList listProviderStaff(curam.cpm.sl.entity.struct.ProviderKey providerKey)
                                                                                                  throws curam.util.exception.AppException,
                                                                                                         curam.util.exception.InformationalException

Returns a list of member staff for the specified provider. This method is intended to be used by users responsible for the planning and delivery of services to clients on a case.

Parameters:

providerKey - unique identifier of the provider to get member staff for

Returns:

list of the provider member staff for the specified provider

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

viewBackgroundCheck

@AccessLevel(value=EXTERNAL)
curam.cpm.facade.struct.ProviderBackgroundCheckSummaryDetails viewBackgroundCheck(curam.cpm.sl.entity.struct.ProviderBackgroundCheckKey providerBackgroundCheckKey)
                                                                                                        throws curam.util.exception.AppException,
                                                                                                               curam.util.exception.InformationalException

This method retrieves all the details of the background check and displays 'active' background check failure reasons, if any exist. This method is intended to be used by users responsible for the planning and delivery of services to clients on a case.

Parameters:

providerBackgroundCheckKey - unique identifier for the provider background check record

Returns:

the provider background check details

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

listProviderEvaluationsForService

@AccessLevel(value=EXTERNAL)
curam.cpm.facade.struct.ServiceEvaluationList listProviderEvaluationsForService(curam.cpm.sl.entity.struct.ProviderKey providerKey,
                                                                                                             curam.cpm.facade.struct.ServiceOfferingKey serviceKey)
                                                                                                      throws curam.util.exception.AppException,
                                                                                                             curam.util.exception.InformationalException

Returns a list of evaluations recorded for the specified provider offering the specified service.

Parameters:

providerKey - unique identifier of the provider

serviceKey - unique identifier of the service

Returns:

a list of evaluations, sorted by creation date, for the providers delivery of the specified service

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException