curam.cpm.facade.intf

Interface Provider

All Known Implementing Classes:

Provider, curam.cpm.facade.impl.Provider, ProviderFactory

@AccessLevel(value=EXTERNAL)
public interface Provider

This Process class describes the operations required for maintaining a provider's details. A Resource Manager or Resource Manager Supervisor manages provider details from the Resource Manager and Resource Manager Supervisor application.

Method Summary

Modifier and Type	Method and Description
void	addRegPersonAsProvider(curam.cpm.facade.struct.ProviderRegistrationOptionDetails Key) Method used to identify registered person as provider.This is one of the steps involved in Provider Enrollment process.This is accessed by the user, Resource Manager and Resource Manager Supervisor from the Resource Manager and Resource Manager Supervisor application.
curam.cpm.sl.entity.struct.ProviderKey	approveProvider(curam.cpm.sl.entity.struct.ProviderStatusUpdateDetails details) Method used to approve a provider.
curam.cpm.sl.entity.struct.ProviderKey	closeProvider(curam.cpm.sl.entity.struct.ProviderStatusUpdateDetails details) Deprecated. Since Curam 6.0.5.4, replaced with Provider#performCloseProvider(ProviderStatusDetails Method used to close a provider. This is accessed by the user, Resource Manager and Resource Manager Supervisor from the Resource Manager and Resource Manager Supervisor application.
curam.cpm.sl.entity.struct.ProviderCategoryPeriodKey	createProviderCategory(curam.cpm.facade.struct.ProviderCategoryDetails providerCategoryDetails) Method used by Resource Manager and Resource Manager Supervisor to create provider category for a provider.
curam.cpm.sl.entity.struct.ProviderEnrollmentReferenceKey	createProviderEnrollment(curam.cpm.facade.struct.ProviderEnrollmentDetails details) Method used to enroll or register a provider participant type.
void	deleteProviderCategory(curam.cpm.facade.struct.KeyVersionDetails providerCategoryKey) Method used by Resource Manager and Resource Manager Supervisor to cancel the provider category and its associated provider type for a provider.
curam.cpm.facade.struct.ProviderCategoryDetailsList	listProviderCategories(curam.cpm.sl.entity.struct.ProviderConcernRoleKey key) Method used by Resource Manager and Resource Manager Supervisor to list all the provider category for a provider.
curam.cpm.facade.struct.SearchProviderDetailsList	listProvidersForResourceManager() Deprecated. Since Curam 6.0, replaced by MaintainProvider.listProvidersForResourceManager(). This method is not useful for displaying user full name as well as conditional display of links in list of providers for resource manager. Hence this method is deprecated. The newly added method will give the option to the user to display the user full name as well as conditional display links. See release note: CR00237197.
void	modifyProviderCategory(curam.cpm.facade.struct.ProviderCategoryDetails providerCategoryDetails) Method used by Resource Manager and Resource Manager Supervisor to update the provider category information and its related provider type information for a provider.
curam.cpm.sl.entity.struct.ProviderKey	performCloseProvider(curam.cpm.sl.entity.struct.ProviderStatusDetails details) Method used to close a provider.
curam.cpm.facade.struct.SearchProviderKey	readWizardDetails(curam.core.sl.struct.WizardStateID wizardDStateID) Method reads the wizard stateid and returns the wizard persistent data.
curam.core.facade.struct.PersonRegistrationResult	registerProviderPerson(curam.cpm.facade.struct.RegisterProviderPersonDetails details) Method used to register a provider as a person.This is accessed by the user, Resource Manager and Resource Manager Supervisor from the Resource Manager and Resource Manager Supervisor application.
curam.cpm.sl.entity.struct.ProviderKey	rejectProvider(curam.cpm.facade.struct.ProviderRejectReasonUpdateDetails details) Method used to reject a provider.
curam.cpm.sl.entity.struct.ProviderKey	reopenProvider(curam.cpm.sl.entity.struct.ProviderStatusUpdateDetails details) Method used to re-open a provider which is closed.
curam.cpm.facade.struct.SearchProviderAndEnquiryConfirmDetails	searchProviderAndEnquiryDetails(curam.cpm.facade.struct.SearchProviderKey searchProviderKey, curam.core.sl.struct.WizardStateID wizardStateID, curam.core.facade.struct.ActionIDProperty actionID) Method used to search all providers and provider enquiries in Open state, which are registered with the organisation.Before the provider is enrolled, the search can be done to ensure that provider is not already enrolled or has any open enquiries registered.
curam.cpm.facade.struct.SearchProviderAndEnquiryConfirmationDetails	searchProvidersAndEnquiries(curam.cpm.sl.entity.struct.SearchProviderEnrollmentKey key) Deprecated. Since Curam 6.0.5.6, replaced by searchProviderAndEnquiryDetails.See release note: CR00440019. Method used to search all providers and provider enquiries in Open state, which are registered with the organisation.Before the provider is enrolled, the search can be done to ensure that provider is not already enrolled or has any open enquiries registered. This is accessed by the user, Resource Manager and Resource Manager Supervisor from the Resource Manager and Resource Manager Supervisor application.
curam.cpm.facade.struct.SearchProviderServiceOfferingResultsList	searchProviderServiceOffering(curam.cpm.sl.entity.struct.ProviderServiceOfferingSearchKey key) Searches for the list of providers for a given service offering.
curam.core.sl.struct.WizardStateID	setProviderWizardDetails(curam.cpm.facade.struct.ProviderSearchWizardDetails wizardStateID) Method used to set the provider wizard details .
curam.cpm.facade.struct.ProviderReasonStatusUpdateDetails	suspendProvider(curam.cpm.facade.struct.ProviderReasonStatusUpdateDetails details) Method used to suspend a provider.
curam.cpm.facade.struct.ViewProviderCategoryDetails	viewProviderCategory(curam.cpm.sl.entity.struct.ProviderCategoryPeriodKey providerCategoryKey) Method used by Resource Manager and Resource Manager Supervisor to view the provider category information and its associated provider type information for a provider.
curam.cpm.facade.struct.ProviderStatusHistoryDetailsList	viewProviderStatusHistory(curam.cpm.sl.entity.struct.ProviderConcernRoleKey key) Method used to display the list of Provider Status History.
curam.cpm.facade.struct.ViewProviderCategoryDetails	viewTypesForPrimaryCategory(curam.cpm.facade.struct.ProviderConcernRoleKey key) Retrieves the list of provider types for the primary category associated with a provider.

Method Detail

createProviderEnrollment

@AccessLevel(value=EXTERNAL)
curam.cpm.sl.entity.struct.ProviderEnrollmentReferenceKey createProviderEnrollment(curam.cpm.facade.struct.ProviderEnrollmentDetails details)
                                                                                                         throws curam.util.exception.AppException,
                                                                                                                curam.util.exception.InformationalException

Method used to enroll or register a provider participant type. This is accessed by the user, Resource Manager and Resource Manager Supervisor from the Resource Manager and Resource Manager Supervisor application.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

approveProvider

@AccessLevel(value=EXTERNAL)
curam.cpm.sl.entity.struct.ProviderKey approveProvider(curam.cpm.sl.entity.struct.ProviderStatusUpdateDetails details)
                                                                             throws curam.util.exception.AppException,
                                                                                    curam.util.exception.InformationalException

Method used to approve a provider. This is accessed by the user, Resource Manager and Resource Manager Supervisor from the Resource Manager and Resource Manager Supervisor application.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

listProvidersForResourceManager

@Deprecated
 @AccessLevel(value=EXTERNAL)
curam.cpm.facade.struct.SearchProviderDetailsList listProvidersForResourceManager()
                                                                                                                     throws curam.util.exception.AppException,
                                                                                                                            curam.util.exception.InformationalException

Deprecated. Since Curam 6.0, replaced by MaintainProvider.listProvidersForResourceManager(). This method is not useful for displaying user full name as well as conditional display of links in list of providers for resource manager. Hence this method is deprecated. The newly added method will give the option to the user to display the user full name as well as conditional display links. See release note: CR00237197.

Method used to display a list of all providers that are assigned to the resource manager. This is accessed by the user, Resource Manager and Resource Manager Supervisor from the Resource Manager and Resource Manager Supervisor application.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

suspendProvider

@AccessLevel(value=EXTERNAL)
curam.cpm.facade.struct.ProviderReasonStatusUpdateDetails suspendProvider(curam.cpm.facade.struct.ProviderReasonStatusUpdateDetails details)
                                                                                                throws curam.util.exception.AppException,
                                                                                                       curam.util.exception.InformationalException

Method used to suspend a provider. This is accessed by the user, Resource Manager and Resource Manager Supervisor from the Resource Manager and Resource Manager Supervisor application.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

rejectProvider

@AccessLevel(value=EXTERNAL)
curam.cpm.sl.entity.struct.ProviderKey rejectProvider(curam.cpm.facade.struct.ProviderRejectReasonUpdateDetails details)
                                                                            throws curam.util.exception.AppException,
                                                                                   curam.util.exception.InformationalException

Method used to reject a provider. This is accessed by the user, Resource Manager and Resource Manager Supervisor from the Resource Manager and Resource Manager Supervisor application.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

closeProvider

@Deprecated
 @AccessLevel(value=EXTERNAL)
curam.cpm.sl.entity.struct.ProviderKey closeProvider(curam.cpm.sl.entity.struct.ProviderStatusUpdateDetails details)
                                                                                        throws curam.util.exception.AppException,
                                                                                               curam.util.exception.InformationalException

Deprecated. Since Curam 6.0.5.4, replaced with Provider#performCloseProvider(ProviderStatusDetails Method used to close a provider. This is accessed by the user, Resource Manager and Resource Manager Supervisor from the Resource Manager and Resource Manager Supervisor application.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

reopenProvider

@AccessLevel(value=EXTERNAL)
curam.cpm.sl.entity.struct.ProviderKey reopenProvider(curam.cpm.sl.entity.struct.ProviderStatusUpdateDetails details)
                                                                            throws curam.util.exception.AppException,
                                                                                   curam.util.exception.InformationalException

Method used to re-open a provider which is closed. This is accessed by the user, Resource Manager and Resource Manager Supervisor from the Resource Manager and Resource Manager Supervisor application.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

searchProvidersAndEnquiries

@Deprecated
 @AccessLevel(value=EXTERNAL)
curam.cpm.facade.struct.SearchProviderAndEnquiryConfirmationDetails searchProvidersAndEnquiries(curam.cpm.sl.entity.struct.SearchProviderEnrollmentKey key)
                                                                                                                                   throws curam.util.exception.AppException,
                                                                                                                                          curam.util.exception.InformationalException

Deprecated. Since Curam 6.0.5.6, replaced by searchProviderAndEnquiryDetails.See release note: CR00440019. Method used to search all providers and provider enquiries in Open state, which are registered with the organisation.Before the provider is enrolled, the search can be done to ensure that provider is not already enrolled or has any open enquiries registered. This is accessed by the user, Resource Manager and Resource Manager Supervisor from the Resource Manager and Resource Manager Supervisor application.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

viewProviderStatusHistory

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

Method used to display the list of Provider Status History. The status will change through the lifecycle of the provider.This is accessed by the user, Resource Manager and Resource Manager Supervisor from the Resource Manager and Resource Manager Supervisor application.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

listProviderCategories

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

Method used by Resource Manager and Resource Manager Supervisor to list all the provider category for a provider.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

registerProviderPerson

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.PersonRegistrationResult registerProviderPerson(curam.cpm.facade.struct.RegisterProviderPersonDetails details)
                                                                                               throws curam.util.exception.AppException,
                                                                                                      curam.util.exception.InformationalException

Method used to register a provider as a person.This is accessed by the user, Resource Manager and Resource Manager Supervisor from the Resource Manager and Resource Manager Supervisor application.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

addRegPersonAsProvider

@AccessLevel(value=EXTERNAL)
void addRegPersonAsProvider(curam.cpm.facade.struct.ProviderRegistrationOptionDetails Key)
                                                  throws curam.util.exception.AppException,
                                                         curam.util.exception.InformationalException

Method used to identify registered person as provider.This is one of the steps involved in Provider Enrollment process.This is accessed by the user, Resource Manager and Resource Manager Supervisor from the Resource Manager and Resource Manager Supervisor application.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

createProviderCategory

@AccessLevel(value=EXTERNAL)
curam.cpm.sl.entity.struct.ProviderCategoryPeriodKey createProviderCategory(curam.cpm.facade.struct.ProviderCategoryDetails providerCategoryDetails)
                                                                                                  throws curam.util.exception.AppException,
                                                                                                         curam.util.exception.InformationalException

Method used by Resource Manager and Resource Manager Supervisor to create provider category for a provider. This method will also create the associated provider type for the category. If the category created is primary then already existing primary category is modified to remove the primary indicator.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

viewProviderCategory

@AccessLevel(value=EXTERNAL)
curam.cpm.facade.struct.ViewProviderCategoryDetails viewProviderCategory(curam.cpm.sl.entity.struct.ProviderCategoryPeriodKey providerCategoryKey)
                                                                                               throws curam.util.exception.AppException,
                                                                                                      curam.util.exception.InformationalException

Method used by Resource Manager and Resource Manager Supervisor to view the provider category information and its associated provider type information for a provider.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

modifyProviderCategory

@AccessLevel(value=EXTERNAL)
void modifyProviderCategory(curam.cpm.facade.struct.ProviderCategoryDetails providerCategoryDetails)
                                                  throws curam.util.exception.AppException,
                                                         curam.util.exception.InformationalException

Method used by Resource Manager and Resource Manager Supervisor to update the provider category information and its related provider type information for a provider. If the category is updated to primary then already existing primary category is modified to remove the primary indicator.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

deleteProviderCategory

@AccessLevel(value=EXTERNAL)
void deleteProviderCategory(curam.cpm.facade.struct.KeyVersionDetails providerCategoryKey)
                                                  throws curam.util.exception.AppException,
                                                         curam.util.exception.InformationalException

Method used by Resource Manager and Resource Manager Supervisor to cancel the provider category and its associated provider type for a provider.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

searchProviderServiceOffering

@AccessLevel(value=EXTERNAL)
curam.cpm.facade.struct.SearchProviderServiceOfferingResultsList searchProviderServiceOffering(curam.cpm.sl.entity.struct.ProviderServiceOfferingSearchKey key)
                                                                                                                     throws curam.util.exception.AppException,
                                                                                                                            curam.util.exception.InformationalException

Searches for the list of providers for a given service offering.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

viewTypesForPrimaryCategory

@AccessLevel(value=EXTERNAL)
curam.cpm.facade.struct.ViewProviderCategoryDetails viewTypesForPrimaryCategory(curam.cpm.facade.struct.ProviderConcernRoleKey key)
                                                                                                      throws curam.util.exception.AppException,
                                                                                                             curam.util.exception.InformationalException

Retrieves the list of provider types for the primary category associated with a provider.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

performCloseProvider

@AccessLevel(value=EXTERNAL)
curam.cpm.sl.entity.struct.ProviderKey performCloseProvider(curam.cpm.sl.entity.struct.ProviderStatusDetails details)
                                                                                  throws curam.util.exception.AppException,
                                                                                         curam.util.exception.InformationalException

Method used to close a provider. This is accessed by the user, Resource Manager and Resource Manager Supervisor from the Resource Manager and Resource Manager Supervisor application.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

readWizardDetails

@AccessLevel(value=EXTERNAL)
curam.cpm.facade.struct.SearchProviderKey readWizardDetails(curam.core.sl.struct.WizardStateID wizardDStateID)
                                                                                  throws curam.util.exception.AppException,
                                                                                         curam.util.exception.InformationalException

Method reads the wizard stateid and returns the wizard persistent data.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

setProviderWizardDetails

@AccessLevel(value=EXTERNAL)
curam.core.sl.struct.WizardStateID setProviderWizardDetails(curam.cpm.facade.struct.ProviderSearchWizardDetails wizardStateID)
                                                                                  throws curam.util.exception.AppException,
                                                                                         curam.util.exception.InformationalException

Method used to set the provider wizard details .

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

searchProviderAndEnquiryDetails

@AccessLevel(value=EXTERNAL)
curam.cpm.facade.struct.SearchProviderAndEnquiryConfirmDetails searchProviderAndEnquiryDetails(curam.cpm.facade.struct.SearchProviderKey searchProviderKey,
                                                                                                                            curam.core.sl.struct.WizardStateID wizardStateID,
                                                                                                                            curam.core.facade.struct.ActionIDProperty actionID)
                                                                                                                     throws curam.util.exception.AppException,
                                                                                                                            curam.util.exception.InformationalException

Method used to search all providers and provider enquiries in Open state, which are registered with the organisation.Before the provider is enrolled, the search can be done to ensure that provider is not already enrolled or has any open enquiries registered. This is accessed by the user, Resource Manager and Resource Manager Supervisor from the Resource Manager and Resource Manager Supervisor application.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException