curam.cpm.facade.intf

Interface ContractManagement

All Known Implementing Classes:

ContractManagement, curam.cpm.facade.impl.ContractManagement, ContractManagementFactory

@AccessLevel(value=EXTERNAL)
public interface ContractManagement

This business interface is used for managing the functionality related to contracts. A provider or a provider group can enter in to a contract with the agency to deliver services to clients. A resource manager oversees the creation and management of contracts with providers and provider groups. The contract can be either a flat rate contract or a utilization contract.

Method Summary

Modifier and Type	Method and Description
void	activateContract(curam.cpm.facade.struct.ActivateContractDetails details) Activates a contract and generates a contract activation notification.
curam.cpm.facade.struct.ProviderOfferingPlaceLimitInformationalDtls	addContractedPlaceLimitForProvider(curam.cpm.facade.struct.ContractedPlaceLimitDetails placeLimitDetails, curam.cpm.sl.entity.struct.ContractPOLinkKey contractPOLinkKey) Creates a place limit for a service associated with a contract for a provider.
curam.attachmentlink.struct.AttachmentLinkKey	createContractAttachment(curam.attachmentlink.struct.AttachmentLinkDetails attachmentLinkDetails) Creates a new attachment to a contract associated with a provider or provider group.
void	createContractContact(curam.cpm.facade.struct.CreateContactDetails details) Creates a contact for a contract associated with a provider or provider group.
void	deleteContractContact(curam.cpm.facade.struct.DeleteContactKey key) Cancels a contract contact.
void	deleteProviderOfferingFromContract(curam.cpm.sl.entity.struct.ContractPOLinkKey contractPOLinkKey) Removes a provider service associated with a provider/provider group contract.
void	generateContract(curam.cpm.facade.struct.GenerateContractDetails dtls) Generates the contract for the user to view and/or print.
curam.cpm.facade.struct.ContractOwnerDetails	getContractOwnerDetails(curam.cpm.sl.entity.struct.ContractVersionKey contractVersionKey) Gets the contract owner details.
curam.attachmentlink.struct.ListAttachmentLinkDetails	listContractAttachment(curam.cpm.sl.entity.struct.ContractVersionKey contractVersionKey) Returns the list of attachments on a contract.
curam.cpm.facade.struct.ContractViewDetailsList	listProviderContracts(curam.cpm.sl.entity.struct.ProviderConcernRoleKey providerKey) Returns the list of contracts associated to a provider.
curam.cpm.facade.struct.ProviderDetailsList	listProviderGroupAssociatesForProviderGroup(curam.cpm.sl.entity.struct.ProviderGroupKey key) Returns the list of providers associated with a given provider group.
curam.cpm.facade.struct.ContractViewDetailsList	listProviderGroupContracts(curam.cpm.sl.entity.struct.ProviderGroupKey providerGroupKey) Returns the list of contracts associated to a provider group.
curam.cpm.facade.struct.ProviderOfferingContactsList	listProviderOfferingsContacts(curam.cpm.sl.entity.struct.ProviderKey key) Returns the list of provider services and contacts that can be associated with a flat-rate contract for a provider.
curam.cpm.facade.struct.ContractContactDetailsList	listProviderParties(curam.core.struct.ConcernRoleKey key) Returns the list of provider parties for a provider.
curam.cpm.facade.struct.ProviderOfferingContactsList	listProviderServicesAndContactsForUtilizationContract(curam.cpm.sl.entity.struct.ProviderKey key) Returns the list of provider services and contacts that can be associated with a utilization contract of a provider/ provider group.
void	modifyContractContact(curam.cpm.facade.struct.ModifyContractContactDetails details) Modifies a contract contact.
curam.core.struct.InformationalMsgDtlsList	modifyContractProviderOfferings(curam.cpm.sl.entity.struct.ContractVersionKey contractVersionKey, curam.cpm.facade.struct.ProviderOfferingTabbedList providerOfferingTabbedList) Modifies the list of provider services for a given contract for a provider.
curam.core.struct.InformationalMsgDtlsList	modifyContractProviderOfferingsForProviderGroupContract(curam.cpm.sl.entity.struct.ContractVersionKey contractVersionKey, curam.cpm.facade.struct.ProviderOfferingTabbedList providerOfferingTabbedList) Modifies the list of provider services for a given contract for a provider group.
curam.cpm.facade.struct.ContractReturnDocDetails	previewContract(curam.cpm.sl.entity.struct.ContractVersionKey key) Generates a PDF document of the contract for preview.
void	printContract(curam.cpm.sl.entity.struct.ContractVersionKey key) Prints a generated contract.
curam.cpm.facade.struct.ViewContractContactDtls	readContractContact(curam.cpm.facade.struct.ReadContactKey key) Returns the details of a contract contact and the list of all provider parties associated with the provider.
curam.core.struct.InformationalMsgDtlsList	renewContract(curam.cpm.facade.struct.RenewContractDetails key) Renews a contract.
void	terminateContract(curam.cpm.facade.struct.TerminateContractDetails details) Terminates a contract of a provider or provider group and generates a contract termination notification.
curam.cpm.facade.struct.ViewProviderOfferingDetails	viewProviderOfferingByContractVersionProviderOffering(curam.cpm.sl.entity.struct.ContractPOLinkKey key) Returns the details of a provider service (including rates and place limits) associated with a contract of a provider group.
curam.cpm.facade.struct.ProviderOfferingDetailsList	viewProviderOfferingsForProviderContract(curam.cpm.facade.struct.ProviderContractKey key) Returns the list of available provider services of a contract, and a tabbed list of provider services currently associated with the contract of a provider.
curam.cpm.facade.struct.ProviderOfferingDetailsList	viewProviderOfferingsForProviderGroupContract(curam.cpm.facade.struct.ProviderContractKey key) Returns the list of available provider services of a contract, and a tabbed list of provider service keys currently associated with the contract of a provider group.
curam.cpm.facade.struct.ViewRenewContractDetails	viewRenewContractDetails(curam.cpm.sl.entity.struct.ContractVersionKey key) Returns the start date of a contract to be renewed.

Method Detail

activateContract

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

Activates a contract and generates a contract activation notification.

Parameters:

details - The key of the contract, date signed and the version number.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

FlatRateContract, UtilizationContract

addContractedPlaceLimitForProvider

@AccessLevel(value=EXTERNAL)
curam.cpm.facade.struct.ProviderOfferingPlaceLimitInformationalDtls addContractedPlaceLimitForProvider(curam.cpm.facade.struct.ContractedPlaceLimitDetails placeLimitDetails,
                                                                                                                                    curam.cpm.sl.entity.struct.ContractPOLinkKey contractPOLinkKey)
                                                                                                                             throws curam.util.exception.AppException,
                                                                                                                                    curam.util.exception.InformationalException

Creates a place limit for a service associated with a contract for a provider.

Parameters:

placeLimitDetails - Contains the place limit, the start date and the end date.

contractPOLinkKey - The key of the contract provider service.

Returns:

The key of the provider service place limit and the list of informational messages obtained during creation.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

ProviderServicePlaceLimit, FlatRateContract, UtilizationContract

createContractContact

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

Creates a contact for a contract associated with a provider or provider group.

Parameters:

details - The details containing the contract contact key, the start date, the end date and the provider party key.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

ContractContact

deleteContractContact

@AccessLevel(value=EXTERNAL)
void deleteContractContact(curam.cpm.facade.struct.DeleteContactKey key)
                                                 throws curam.util.exception.AppException,
                                                        curam.util.exception.InformationalException

Cancels a contract contact.

Parameters:

key - The key of the contract contact and the version number.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

ContractContact

deleteProviderOfferingFromContract

@AccessLevel(value=EXTERNAL)
void deleteProviderOfferingFromContract(curam.cpm.sl.entity.struct.ContractPOLinkKey contractPOLinkKey)
                                                              throws curam.util.exception.AppException,
                                                                     curam.util.exception.InformationalException

Removes a provider service associated with a provider/provider group contract.

Parameters:

contractPOLinkKey - The key of the contract provider service.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

FlatRateContract, UtilizationContract

generateContract

@AccessLevel(value=EXTERNAL)
void generateContract(curam.cpm.facade.struct.GenerateContractDetails dtls)
                                            throws curam.util.exception.AppException,
                                                   curam.util.exception.InformationalException

Generates the contract for the user to view and/or print. When a contract is generated, the status is changed to 'Issued'.

Parameters:

dtls - The key of the contract, the generation reason, the version number.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

FlatRateContract, UtilizationContract

listProviderGroupAssociatesForProviderGroup

@AccessLevel(value=EXTERNAL)
curam.cpm.facade.struct.ProviderDetailsList listProviderGroupAssociatesForProviderGroup(curam.cpm.sl.entity.struct.ProviderGroupKey key)
                                                                                                              throws curam.util.exception.AppException,
                                                                                                                     curam.util.exception.InformationalException

Returns the list of providers associated with a given provider group.

Parameters:

key - The key of the provider group.

Returns:

The list of provider details.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

ProviderGroup

listProviderOfferingsContacts

@AccessLevel(value=EXTERNAL)
curam.cpm.facade.struct.ProviderOfferingContactsList listProviderOfferingsContacts(curam.cpm.sl.entity.struct.ProviderKey key)
                                                                                                         throws curam.util.exception.AppException,
                                                                                                                curam.util.exception.InformationalException

Returns the list of provider services and contacts that can be associated with a flat-rate contract for a provider.

Parameters:

key - The key of the provider.

Returns:

The list of provider services and contacts.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

ProviderService, ProviderParty, FlatRateContract

listProviderParties

@AccessLevel(value=EXTERNAL)
curam.cpm.facade.struct.ContractContactDetailsList listProviderParties(curam.core.struct.ConcernRoleKey key)
                                                                                             throws curam.util.exception.AppException,
                                                                                                    curam.util.exception.InformationalException

Returns the list of provider parties for a provider. A provider party is an individual associated to the provider who has a significant internal relationship to the provider.

Parameters:

The - key of the provider.

Returns:

The list of provider party details.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

ProviderParty

modifyContractContact

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

Modifies a contract contact.

Parameters:

details - The details containing contract key, contract contact key, start date, end date and version number.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

ContractContact

modifyContractProviderOfferings

@AccessLevel(value=EXTERNAL)
curam.core.struct.InformationalMsgDtlsList modifyContractProviderOfferings(curam.cpm.sl.entity.struct.ContractVersionKey contractVersionKey,
                                                                                                        curam.cpm.facade.struct.ProviderOfferingTabbedList providerOfferingTabbedList)
                                                                                                 throws curam.util.exception.AppException,
                                                                                                        curam.util.exception.InformationalException

Modifies the list of provider services for a given contract for a provider.

Parameters:

contractVersionKey - The key of the contract.

providerOfferingTabbedList - The tabbed list of provider services.

Returns:

The List of informational messages obtained during modification process.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

FlatRateContract, UtilizationContract, ProviderService

modifyContractProviderOfferingsForProviderGroupContract

@AccessLevel(value=EXTERNAL)
curam.core.struct.InformationalMsgDtlsList modifyContractProviderOfferingsForProviderGroupContract(curam.cpm.sl.entity.struct.ContractVersionKey contractVersionKey,
                                                                                                                                curam.cpm.facade.struct.ProviderOfferingTabbedList providerOfferingTabbedList)
                                                                                                                         throws curam.util.exception.AppException,
                                                                                                                                curam.util.exception.InformationalException

Modifies the list of provider services for a given contract for a provider group.

Parameters:

contractVersionKey - The key of the contract.

providerOfferingTabbedList - The tabbed list of provider services

Returns:

The list of informational messages during modification process.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

FlatRateContract, UtilizationContract, ProviderService

previewContract

@AccessLevel(value=EXTERNAL)
curam.cpm.facade.struct.ContractReturnDocDetails previewContract(curam.cpm.sl.entity.struct.ContractVersionKey key)
                                                                                       throws curam.util.exception.AppException,
                                                                                              curam.util.exception.InformationalException

Generates a PDF document of the contract for preview.

Parameters:

key - The key of the contract.

Returns:

The contract document details containing the document name and the document content as a BLOB.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

FlatRateContract, UtilizationContract

printContract

@AccessLevel(value=EXTERNAL)
void printContract(curam.cpm.sl.entity.struct.ContractVersionKey key)
                                         throws curam.util.exception.AppException,
                                                curam.util.exception.InformationalException

Prints a generated contract.

Parameters:

key - The key of the contract.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

FlatRateContract, UtilizationContract

readContractContact

@AccessLevel(value=EXTERNAL)
curam.cpm.facade.struct.ViewContractContactDtls readContractContact(curam.cpm.facade.struct.ReadContactKey key)
                                                                                          throws curam.util.exception.AppException,
                                                                                                 curam.util.exception.InformationalException

Returns the details of a contract contact and the list of all provider parties associated with the provider.

Parameters:

key - The key of the contract contact and the provider.

Returns:

The contract contact and provider party details.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

ContractContact, ProviderParty

renewContract

@AccessLevel(value=EXTERNAL)
curam.core.struct.InformationalMsgDtlsList renewContract(curam.cpm.facade.struct.RenewContractDetails key)
                                                                               throws curam.util.exception.AppException,
                                                                                      curam.util.exception.InformationalException

Renews a contract. This creates a new copy of the contract, starting the day after the original contract ended.

Parameters:

key - The key of the contract, the new start date, the end date and the version number.

Returns:

List of informational messages obtained during renewal.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

FlatRateContract, UtilizationContract

terminateContract

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

Terminates a contract of a provider or provider group and generates a contract termination notification.

Parameters:

details - The key of the contract, the termination reason and the version number.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

FlatRateContract, UtilizationContract

viewProviderOfferingByContractVersionProviderOffering

@AccessLevel(value=EXTERNAL)
curam.cpm.facade.struct.ViewProviderOfferingDetails viewProviderOfferingByContractVersionProviderOffering(curam.cpm.sl.entity.struct.ContractPOLinkKey key)
                                                                                                                                throws curam.util.exception.AppException,
                                                                                                                                       curam.util.exception.InformationalException

Returns the details of a provider service (including rates and place limits) associated with a contract of a provider group.

Parameters:

key - The key of the contract provider service.

Returns:

The provider service details.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

FlatRateContract, UtilizationContract, ProviderService

viewProviderOfferingsForProviderContract

@AccessLevel(value=EXTERNAL)
curam.cpm.facade.struct.ProviderOfferingDetailsList viewProviderOfferingsForProviderContract(curam.cpm.facade.struct.ProviderContractKey key)
                                                                                                                   throws curam.util.exception.AppException,
                                                                                                                          curam.util.exception.InformationalException

Returns the list of available provider services of a contract, and a tabbed list of provider services currently associated with the contract of a provider.

Parameters:

key - The key of the provider and the contract.

Returns:

The list of services.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

FlatRateContract, UtilizationContract, Provider

viewProviderOfferingsForProviderGroupContract

@AccessLevel(value=EXTERNAL)
curam.cpm.facade.struct.ProviderOfferingDetailsList viewProviderOfferingsForProviderGroupContract(curam.cpm.facade.struct.ProviderContractKey key)
                                                                                                                        throws curam.util.exception.AppException,
                                                                                                                               curam.util.exception.InformationalException

Returns the list of available provider services of a contract, and a tabbed list of provider service keys currently associated with the contract of a provider group.

Parameters:

key - The key of the contract.

Returns:

The list of services.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

FlatRateContract, UtilizationContract

viewRenewContractDetails

@AccessLevel(value=EXTERNAL)
curam.cpm.facade.struct.ViewRenewContractDetails viewRenewContractDetails(curam.cpm.sl.entity.struct.ContractVersionKey key)
                                                                                                throws curam.util.exception.AppException,
                                                                                                       curam.util.exception.InformationalException

Returns the start date of a contract to be renewed. It is one day after the contract end date.

Parameters:

key - The key of the contract.

Returns:

The contract renewal start date.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

FlatRateContract, UtilizationContract

createContractAttachment

@AccessLevel(value=EXTERNAL)
curam.attachmentlink.struct.AttachmentLinkKey createContractAttachment(curam.attachmentlink.struct.AttachmentLinkDetails attachmentLinkDetails)
                                                                                             throws curam.util.exception.AppException,
                                                                                                    curam.util.exception.InformationalException

Creates a new attachment to a contract associated with a provider or provider group.

Parameters:

attachmentLinkDetails - The details to create an attachment to a contract.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

FlatRateContract, UtilizationContract, Attachment

listContractAttachment

@AccessLevel(value=EXTERNAL)
curam.attachmentlink.struct.ListAttachmentLinkDetails listContractAttachment(curam.cpm.sl.entity.struct.ContractVersionKey contractVersionKey)
                                                                                                   throws curam.util.exception.AppException,
                                                                                                          curam.util.exception.InformationalException

Returns the list of attachments on a contract.

Parameters:

key - The key of the contract.

Returns:

The list of attachment details.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

FlatRateContract, UtilizationContract, Attachment

listProviderContracts

@AccessLevel(value=EXTERNAL)
curam.cpm.facade.struct.ContractViewDetailsList listProviderContracts(curam.cpm.sl.entity.struct.ProviderConcernRoleKey providerKey)
                                                                                            throws curam.util.exception.AppException,
                                                                                                   curam.util.exception.InformationalException

Returns the list of contracts associated to a provider.

Parameters:

providerKey - The key of the provider.

Returns:

The list of contracts.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Provider, FlatRateContract, UtilizationContract

listProviderGroupContracts

@AccessLevel(value=EXTERNAL)
curam.cpm.facade.struct.ContractViewDetailsList listProviderGroupContracts(curam.cpm.sl.entity.struct.ProviderGroupKey providerGroupKey)
                                                                                                 throws curam.util.exception.AppException,
                                                                                                        curam.util.exception.InformationalException

Returns the list of contracts associated to a provider group.

Parameters:

providerGroupKey - The key of the provider group.

Returns:

The list of contracts.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

ProviderGroup, FlatRateContract, UtilizationContract

getContractOwnerDetails

@AccessLevel(value=EXTERNAL)
curam.cpm.facade.struct.ContractOwnerDetails getContractOwnerDetails(curam.cpm.sl.entity.struct.ContractVersionKey contractVersionKey)
                                                                                           throws curam.util.exception.AppException,
                                                                                                  curam.util.exception.InformationalException

Gets the contract owner details.

Parameters:

contractVersionKey - The key of the contract.

Returns:

The contract owner details.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

ContractContact

listProviderServicesAndContactsForUtilizationContract

@AccessLevel(value=EXTERNAL)
curam.cpm.facade.struct.ProviderOfferingContactsList listProviderServicesAndContactsForUtilizationContract(curam.cpm.sl.entity.struct.ProviderKey key)
                                                                                                                                 throws curam.util.exception.AppException,
                                                                                                                                        curam.util.exception.InformationalException

Returns the list of provider services and contacts that can be associated with a utilization contract of a provider/ provider group. The provider parties of a provider/provider groups become the contract contacts.

Parameters:

key - The key of the provider.

Returns:

The list of provider services and provider parties.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

ProviderService, ProviderParty, UtilizationContract