curam.cpm.facade.intf

Interface Referral

All Known Implementing Classes:

Referral, curam.cpm.facade.impl.Referral, ReferralFactory

@AccessLevel(value=EXTERNAL)
public interface Referral

Facade class for the Referral.

Method Summary

Modifier and Type	Method and Description
void	cancelReferral(curam.cpm.facade.struct.CancelReferralKey cancelKey) Cancels the Referral.
void	createAttachment(curam.attachmentlink.struct.AttachmentLinkDetails details) Creates an attachment for the Referral.
curam.cpm.sl.struct.ReferralKey	createReferralForCase(curam.cpm.facade.struct.ReferralDetails details) Creates a Referral for an Integrated Case.
curam.cpm.facade.struct.ServiceOfferingDetailsList	listAllReferralServiceOfferings() Lists all Referral Service Offerings in the service registry.
curam.attachmentlink.struct.ListAttachmentLinkDetails	listAttachments(curam.cpm.sl.struct.ReferralKey key) Retrieves a list of the attachments related to the referral.This method is intended to be used by users responsible for the management of Referrals.
curam.cpm.facade.struct.ParticipantRoleDetailsList	listClientsForCase(curam.core.struct.CaseHeaderKey key) Returns the list of participants associated with the case the Referral exists on.
curam.cpm.facade.struct.ParticipantRoleDetailsList	listClientsForUpdate(curam.cpm.sl.struct.ReferralKey referralID) Returns the list of participants associated with the case the Referral exists on, who are not currently part of the Referral.
curam.cpm.facade.struct.NotificationDocumentDetailsList	listNotificationLetters(curam.cpm.sl.struct.ReferralKey key) Retrieves a list of the referral notification letters that have being generated for this referral.
curam.servicedelivery.facade.struct.ListServicesByTermResult	listReferralServicesByTerm(curam.cpm.facade.struct.ListServicesByTermKey1 key) Deprecated. since 7.0.0.0, This functionality forms part of a feature that is no longer relevant to the product strategy and will not be replaced.
curam.cpm.facade.struct.ReferralList	listReferralsForCase(curam.cpm.facade.struct.ListReferralsKey key) Retrieves a list of Referrals that exist on the given case.
curam.cpm.facade.struct.ContextPanelDetails	readContextPanelDetails(curam.cpm.sl.struct.ReferralKey referralKey) Reads the context panel details for a Referral.
curam.cpm.facade.struct.ProviderDetailsForRemove	readProviderDetailsForRemove(curam.cpm.sl.struct.ReferralKey referralKey) Reads the details required for the removal of a Provider from a referral.
curam.cpm.facade.struct.ReadDetailsForProviderSearchResult	readProviderSearchCriteriaProviderListForUpdate(curam.cpm.facade.struct.ReadDetailsForProviderSearchKey key) Reads the details required when adding a Provider to a Referral.
curam.cpm.facade.struct.ReadReferralDetails	readReferralDetails(curam.cpm.sl.struct.ReferralKey referralKey) Reads the details of a Referral.
curam.cpm.facade.struct.VersionNoKey	readVersionNo(curam.cpm.sl.struct.ReferralKey key) Returns the version number of the specified referral record.
void	removeProvider(curam.cpm.sl.struct.ReferralRoleKey referralRoleKey, curam.cpm.facade.struct.VersionNoKey versionNoKey) This method is used to remove a provider from a referral where the provider and clients have not been notified of the referral.
curam.servicedelivery.facade.struct.ServiceSearchResult	searchReferralServices(curam.servicedelivery.facade.struct.ServiceSearchKey key) Deprecated. since 7.0.0.0, This functionality forms part of a feature that is no longer relevant to the product strategy and will not be replaced.
curam.cpm.facade.struct.ListProviderDetailsKey	updateProvider(curam.cpm.facade.struct.UpdateProviderDetails key) This method is used to relate a provider to an existing referral which has no provider associated with it, and the clients have not been notified of the referral.
void	updateReferral(curam.cpm.facade.struct.UpdateReferralDetails details) Updates a Referral.
curam.cpm.facade.struct.ReferralNotificationData	viewNotificationDocument(curam.cpm.facade.struct.NotificationDocumentKey key) Retrieves the Referral letter that was sent or is to be sent to a client or provider.

Method Detail

listNotificationLetters

@AccessLevel(value=EXTERNAL)
curam.cpm.facade.struct.NotificationDocumentDetailsList listNotificationLetters(curam.cpm.sl.struct.ReferralKey key)
                                                                                                      throws curam.util.exception.AppException,
                                                                                                             curam.util.exception.InformationalException

Retrieves a list of the referral notification letters that have being generated for this referral. The list will contain letters for the provider or clients on the referral.This method is intended to be used by users responsible for the management of Referrals.

Parameters:

key - The unique identifer of the referral the retrieved referral notification letters are in relation to

Returns:

List of Referrals letters that have been generated for this referral

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

createReferralForCase

@AccessLevel(value=EXTERNAL)
curam.cpm.sl.struct.ReferralKey createReferralForCase(curam.cpm.facade.struct.ReferralDetails details)
                                                                            throws curam.util.exception.AppException,
                                                                                   curam.util.exception.InformationalException

Creates a Referral for an Integrated Case. This method is intended to be used by users responsible for the management of Referrals.

Parameters:

details - The Referral details for creation.

Returns:

the unique identifier of the created Referral

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

listReferralsForCase

@AccessLevel(value=EXTERNAL)
curam.cpm.facade.struct.ReferralList listReferralsForCase(curam.cpm.facade.struct.ListReferralsKey key)
                                                                                throws curam.util.exception.AppException,
                                                                                       curam.util.exception.InformationalException

Retrieves a list of Referrals that exist on the given case. This method is intended to be used by users responsible for the management of Referrals.

Parameters:

key - The unique identifer of the case the retrieved Referrals exist on

Returns:

List of Referrals that exist on the given case

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

readReferralDetails

@AccessLevel(value=EXTERNAL)
curam.cpm.facade.struct.ReadReferralDetails readReferralDetails(curam.cpm.sl.struct.ReferralKey referralKey)
                                                                                      throws curam.util.exception.AppException,
                                                                                             curam.util.exception.InformationalException

Reads the details of a Referral. This method is intended to be used by users responsible for the management of Referrals.

Parameters:

referralkey - The unique identifier of the Referral to be read.

Returns:

The Referral details

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

updateReferral

@AccessLevel(value=EXTERNAL)
void updateReferral(curam.cpm.facade.struct.UpdateReferralDetails details)
                                          throws curam.util.exception.AppException,
                                                 curam.util.exception.InformationalException

Updates a Referral. This method is intended to be used by users responsible for the management of Referrals.

Parameters:

details - the Referral details to update

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

listClientsForCase

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

Returns the list of participants associated with the case the Referral exists on. This method is intended to be used by users responsible for the management of Referrals.

Parameters:

caseID - the unique identifier for the case.

Returns:

ParticipantRoleDetailsList a list of the case clients' names and concernRoleID's, gender and age.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

createAttachment

@AccessLevel(value=EXTERNAL)
void createAttachment(curam.attachmentlink.struct.AttachmentLinkDetails details)
                                            throws curam.util.exception.AppException,
                                                   curam.util.exception.InformationalException

Creates an attachment for the Referral. This method is intended to be used by users responsible for the management of Referrals.

Parameters:

details - attachment details.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

listClientsForUpdate

@AccessLevel(value=EXTERNAL)
curam.cpm.facade.struct.ParticipantRoleDetailsList listClientsForUpdate(curam.cpm.sl.struct.ReferralKey referralID)
                                                                                              throws curam.util.exception.AppException,
                                                                                                     curam.util.exception.InformationalException

Returns the list of participants associated with the case the Referral exists on, who are not currently part of the Referral. This method is intended to be used by users responsible for the management of Referrals.

Parameters:

referralID - the unique identifier for the Referral.

Returns:

ParticipantRoleDetailsList a list of the case clients' names and concernRoleID's, gender and age

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

viewNotificationDocument

@AccessLevel(value=EXTERNAL)
curam.cpm.facade.struct.ReferralNotificationData viewNotificationDocument(curam.cpm.facade.struct.NotificationDocumentKey key)
                                                                                                throws curam.util.exception.AppException,
                                                                                                       curam.util.exception.InformationalException

Retrieves the Referral letter that was sent or is to be sent to a client or provider. It enables the user to view the details of the letter and optionally print it. This method is intended to be used by users responsible for the management of Referrals.

Parameters:

key - Contains the identifier of the Referral the letter being viewed is in relation to, the concern role document is specifically related to, and the type of document being created

Returns:

The referral letter

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

listAllReferralServiceOfferings

@AccessLevel(value=EXTERNAL)
curam.cpm.facade.struct.ServiceOfferingDetailsList listAllReferralServiceOfferings()
                                                                                                         throws curam.util.exception.AppException,
                                                                                                                curam.util.exception.InformationalException

Lists all Referral Service Offerings in the service registry. This method is intended to be used by users responsible for the management of Referrals.

Returns:

a list of all Referral Service Offerinngs in the service registry

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

readContextPanelDetails

@AccessLevel(value=EXTERNAL)
curam.cpm.facade.struct.ContextPanelDetails readContextPanelDetails(curam.cpm.sl.struct.ReferralKey referralKey)
                                                                                          throws curam.util.exception.AppException,
                                                                                                 curam.util.exception.InformationalException

Reads the context panel details for a Referral. This method is intended to be used by users responsible for the management of Referrals.

Parameters:

referralkey - The unique identifier of the Referral to be read.

Returns:

The Referral details for the details panel

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

listAttachments

@AccessLevel(value=EXTERNAL)
curam.attachmentlink.struct.ListAttachmentLinkDetails listAttachments(curam.cpm.sl.struct.ReferralKey key)
                                                                                            throws curam.util.exception.AppException,
                                                                                                   curam.util.exception.InformationalException

Retrieves a list of the attachments related to the referral.This method is intended to be used by users responsible for the management of Referrals.

Parameters:

key - The unique identifer of the referrals the retrieved attachments are in relation to

Returns:

List of the attachments related to the referral

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

readProviderSearchCriteriaProviderListForUpdate

@AccessLevel(value=EXTERNAL)
curam.cpm.facade.struct.ReadDetailsForProviderSearchResult readProviderSearchCriteriaProviderListForUpdate(curam.cpm.facade.struct.ReadDetailsForProviderSearchKey key)
                                                                                                                                 throws curam.util.exception.AppException,
                                                                                                                                        curam.util.exception.InformationalException

Reads the details required when adding a Provider to a Referral. This method is intended to be used by users responsible for the management of Referrals.

Parameters:

key - The unique identifier of the Referral the details are to be retrieved from.

Returns:

The details required for the adding of a provider to the referral.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

updateProvider

@AccessLevel(value=EXTERNAL)
curam.cpm.facade.struct.ListProviderDetailsKey updateProvider(curam.cpm.facade.struct.UpdateProviderDetails key)
                                                                                    throws curam.util.exception.AppException,
                                                                                           curam.util.exception.InformationalException

This method is used to relate a provider to an existing referral which has no provider associated with it, and the clients have not been notified of the referral. This method is intended to be used by users responsible for the management of Referrals.

Parameters:

referralKey - the unique identifier of the referral the provider is to be related to

providerDetails - the details of the provider to be added to the referral

versionNo - the version number of the referral the proivder is to be related to

Returns:

the search details

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

removeProvider

@AccessLevel(value=EXTERNAL)
void removeProvider(curam.cpm.sl.struct.ReferralRoleKey referralRoleKey,
                                                 curam.cpm.facade.struct.VersionNoKey versionNoKey)
                                          throws curam.util.exception.AppException,
                                                 curam.util.exception.InformationalException

This method is used to remove a provider from a referral where the provider and clients have not been notified of the referral. This method is intended to be used by users responsible for the management of Referrals.

Parameters:

referralRoleKey - unique identifier for the referral role representing the provider to be removed.

versionNoKey - The version number of the referral role

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

readProviderDetailsForRemove

@AccessLevel(value=EXTERNAL)
curam.cpm.facade.struct.ProviderDetailsForRemove readProviderDetailsForRemove(curam.cpm.sl.struct.ReferralKey referralKey)
                                                                                                    throws curam.util.exception.AppException,
                                                                                                           curam.util.exception.InformationalException

Reads the details required for the removal of a Provider from a referral. This method is intended to be used by users responsible for the management of Referrals.

Parameters:

referralkey - The unique identifier of the Referral to the required provider details are to be read from.

Returns:

The details of the provider to be canceled

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

cancelReferral

@AccessLevel(value=EXTERNAL)
void cancelReferral(curam.cpm.facade.struct.CancelReferralKey cancelKey)
                                          throws curam.util.exception.AppException,
                                                 curam.util.exception.InformationalException

Cancels the Referral. This method is intended to be used by users responsible for the management of Referrals.

Parameters:

cancelKey - unique identifier of the Referral to cancel and its version number

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

readVersionNo

@AccessLevel(value=EXTERNAL)
curam.cpm.facade.struct.VersionNoKey readVersionNo(curam.cpm.sl.struct.ReferralKey key)
                                                                         throws curam.util.exception.AppException,
                                                                                curam.util.exception.InformationalException

Returns the version number of the specified referral record.

Parameters:

the - unique identifier of the referral record

Returns:

the version number key

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

listReferralServicesByTerm

@Deprecated
 @AccessLevel(value=EXTERNAL)
curam.servicedelivery.facade.struct.ListServicesByTermResult listReferralServicesByTerm(curam.cpm.facade.struct.ListServicesByTermKey1 key)
                                                                                                                           throws curam.util.exception.AppException,
                                                                                                                                  curam.util.exception.InformationalException

Deprecated. since 7.0.0.0, This functionality forms part of a feature that is no longer relevant to the product strategy and will not be replaced.

Lists all the referral services that have been indexed against a selected taxonomy term.

Parameters:

key - the details to search by

Returns:

the results of the search

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

searchReferralServices

@Deprecated
 @AccessLevel(value=EXTERNAL)
curam.servicedelivery.facade.struct.ServiceSearchResult searchReferralServices(curam.servicedelivery.facade.struct.ServiceSearchKey key)
                                                                                                                  throws curam.util.exception.AppException,
                                                                                                                         curam.util.exception.InformationalException

Deprecated. since 7.0.0.0, This functionality forms part of a feature that is no longer relevant to the product strategy and will not be replaced.

Searches for referral services based on name or taxonomy keywords.

Parameters:

key - the name of the referral service to search for or the taxonomy keywords

Returns:

the list of referral services matching the search criteria

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException