Product (core)

All Known Implementing Classes:

Product, curam.core.facade.impl.Product, ProductFactory
```
@AccessLevel(value=EXTERNAL)
public interface Product
```
This process class contains all the functionality for the Product presentation layer.

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addCategoriesToProduct(curam.core.facade.struct.AddCategoriesToProductKey key)` This method adds one or more product categories to a specified product.
`void`	`addDeductionProductLink(curam.core.facade.struct.AddDeductionKey key)` Adds deductions to a product.
`void`	`addDeliveryPatternCommentsTextTranslation(curam.workspaceservices.facade.struct.LocalizableTextDetails details)` This method is indented to be used by user who creates text translations for the DeliverPattern attribute, Comments.
`void`	`addDeliveryPatternNameTextTranslation(curam.workspaceservices.facade.struct.LocalizableTextDetails localizableTextDetails)` This method is indented to be used by user who creates text translations for the DeliverPattern attribute, name.
`void`	`addExistingMilestone(curam.core.sl.struct.AddMilestoneKey key, curam.core.sl.struct.CaseType caseType)` This parameter will have all the information given by the user while creating a milestone for a particular case.This method helps to add the existing milestone to a selected product from list of milestones which was created earlier for different products.
`void`	`addExistingMilestoneWithConfigDetails(curam.core.sl.struct.AddMilestoneKey key, curam.core.sl.struct.CaseType caseType, curam.core.sl.struct.MilestoneLinkConfigDetails configDetails)` This parameter will have all the information given by the user while creating a milestone for a particular case.This method helps to add the existing milestone to a selected product from list of milestones which was created earlier for different products.
`void`	`addInvestigationCaseExistingMilestone(curam.core.sl.struct.AddMilestoneKey key)` This method allows the user to select milestones to associate with a particular product from a pre-defined list, which displays all active milestones not already associated with a particular product which have an end date greater then or equal to the current date.
`void`	`addInvestigationCaseExistingMilestoneWithConfig(curam.core.sl.struct.AddMilestoneKey key, curam.core.sl.struct.MilestoneLinkConfigDetails configDetails)` This method allows the user to select milestones to associate with a particular product from a pre-defined list, which displays all active milestones not already associated with a particular product which have an end date greater then or equal to the current date.
`void`	`addMilestoneCommentsTextTranslation(curam.workspaceservices.facade.struct.LocalizableTextDetails details)` This method is indented to be used by user who creates translations for Milestone comments.
`void`	`addMilestoneNameTextTranslation(curam.workspaceservices.facade.struct.LocalizableTextDetails details)` This method is indented to be used by user who creates translations for Milestone name.
`void`	`addMilestoneTypeTextTranslation(curam.workspaceservices.facade.struct.LocalizableTextDetails details)` This method is indented to be used by user who creates translations for Milestone type.
`void`	`assignRuleSetToProduct(curam.core.facade.struct.AssignRuleSetToProductDetails details)` Assigns a ruleSet to a product.
`void`	`cancelAdhocBonusCriteria(curam.core.facade.struct.CancelAdhocBonusKey key)` Cancel an ad hoc bonus criteria record.
`void`	`cancelApprovalCheckForInvestigation(curam.core.facade.struct.CancelInvestigationApprovalCheckKey key)` This method allows an administrator to cancel an Investigation Approval Check for a particular investigation.
`void`	`cancelDeliveryPattern(curam.core.facade.struct.CancelDeliveryPatternKey key)` Cancels a delivery pattern.
`void`	`cancelEvidenceApprovalCheck(curam.core.facade.struct.CancelEvidenceApprovalCheckKey key)` Cancels an evidence approval check.
`void`	`cancelEvidenceGroupPage(curam.core.facade.struct.CancelEvidenceGroupPageDetails details)` Cancels an Evidence Group Page for a specific Product.
`void`	`cancelEvidenceMetadata(curam.core.facade.struct.EvidenceMetadataRecordStatusVersionNo details)` Cancels an Evidence Metadata entry.
`void`	`cancelEvidencePage(curam.core.facade.struct.CancelEvidencePageDetails details)` Cancels an Evidence Page for a specific Product.
`void`	`cancelInvestigationConfiguration(curam.core.sl.entity.struct.InvestigationConfigKey key)` Changes the status of the issue configuration record to 'canceled'.
`void`	`cancelInvestigationResolutionLink(curam.core.sl.entity.struct.InvestigationResolutionLinkKey key)` The link between an investigation and a resolution is removed.
`void`	`cancelIssueConfiguration(curam.core.sl.entity.struct.IssueConfigurationKey key)` Changes the status of the issue configuration record to 'canceled'.
`void`	`cancelIssueResolutionLink(curam.core.facade.struct.IssueResolutionLinkKey key)` The link between an issue and a resolution is removed.
`void`	`cancelIssueTimeConstraint(curam.core.sl.entity.struct.IssueTimeConstraintKey key)` Cancels an existing active issue time constraint record.
`void`	`cancelMilestoneConfiguration(curam.core.sl.entity.struct.MilestoneConfigurationKey key)` Changes the status of the milestone configuration record to 'canceled'.
`void`	`cancelProduct(curam.core.facade.struct.CancelProductKey key)` Cancels a product.
`void`	`cancelProductApprovalCheck(curam.core.facade.struct.CancelProductApprovalCheckKey key)` Cancels a product approval check.
`void`	`cancelProductEvidenceFormLink(curam.core.facade.struct.CancelProductEvidenceFormLinkKey key)` Cancels a product evidence form link.
`void`	`cancelProductProvision(curam.core.facade.struct.CancelProductProvisionKey key)` Cancels a product provision.
`void`	`cancelProductTimeConstraint(curam.core.facade.struct.CancelProductTimeConstraint key)` Presentation layer method to cancel a product time constraint record.
`void`	`cancelProvisionLocation(curam.core.facade.struct.CancelProvisionLocationKey key)` Cancels a provision location.
`void`	`cancelResolutionApprovalCheckForIssue(curam.core.facade.struct.CancelIssueResolutionApprovalCheckKey cancelIssueResolutionApprovalCheckKey)` This method allows an administrator to cancel an Issue Resolution Approval Check for a particular issue.
`void`	`cancelRuleSetFromProduct(curam.core.facade.struct.CancelRuleSetFromProductKey key)` Cancels the assignment of a ruleSet to a product.
`void`	`cancelSiteMap(curam.core.facade.struct.CancelSiteMapDetails details)` Cancels a Site Map page for a specific Product.
`void`	`cancelTemporalEvidenceApprovalCheck(curam.core.facade.struct.TemporalEvidenceApprovalCheckKey key, curam.core.facade.struct.ModifyTemporalEvidenceApprovalCheck details)` Deletes a specified temporal evidence approval check.
`void`	`createAbsenceReasonConfiguration(curam.attendance.entity.struct.AbsenceReasonConfigurationDtls dtls)` Creates an absence reason configuration record for the product.
`void`	`createAdhocBonusCriteria(curam.core.facade.struct.CreateAdhocBonusCriteriaDetails details)` Creates an ad hoc bonus criteria record on the system.
`void`	`createAndAddResolutionToInvestigation(curam.core.facade.struct.ResolutionConfigurationDtls resolutionDtls, curam.core.sl.entity.struct.InvestigationConfigKey investigationConfigKey)` Creates and then adds a resolution configuration to an Investigation configuration.
`void`	`createApprovalCheckForInvestigation(curam.core.facade.struct.InvestigationApprovalCheckDetails details)` This method allows an administrator to configure an approval check for a particular investigation.
`void`	`createBenefitProduct1(curam.core.facade.struct.BenefitProductDetails1 details)` Creates a new benefit product.
`void`	`createDeductionAndProductLink(curam.core.facade.struct.CreateDeductionAndProductLinkDetails details)` Creates a new deduction and also associates that deduction with a product.
`void`	`createDeductionProductLink(curam.core.facade.struct.CreateDeductionProductLinkDetails details)` Creates an association between a deduction and a product.
`void`	`createDeliveryPattern(curam.core.facade.struct.CreateDeliveryPatternDetails details)` Deprecated. Since Curam 6.0 SP2, replaced by `Product#createDeliveryPatternInfo()` The existing method,createDeliveryPattern, does not support the display of informational message to be shown when the offset does not have an effect on delivery pattern. Hence the new method createDeliveryPatternInfo has been created, which will validate the offset against a delivery pattern and returns the informational message. See release note: CEF-8154
`curam.core.struct.InformationalMsgDtlsList`	`createDeliveryPatternInfo(curam.core.facade.struct.CreateDeliveryPatternDetails details)` This method is intended to be used by users responsible for administrating product delivery pattern.It is used to create the product delivery pattern.
`void`	`createEvidenceApprovalCheck(curam.core.facade.struct.EvidenceApprovalCheckDtls details)` Creates an evidence approval check.
`void`	`createEvidenceGroupPage(curam.core.facade.struct.CreateEvidenceGroupPageDetails details)` Creates a new Evidence Group Page for a specified Product.
`void`	`createEvidenceMetadata(curam.core.facade.struct.EvidenceMetadataDetails details)` Creates an Evidence Metadata record.
`void`	`createEvidencePage(curam.core.facade.struct.CreateEvidencePageDetails details)` Creates a new Evidence Page for a specified Product.
`void`	`createInvestigationCaseMilestone(curam.core.struct.ProductKey productKey, curam.core.facade.struct.MilestoneConfigurationDtls details)` Create a new milestone for a product.
`void`	`createInvestigationConfiguration(curam.core.facade.struct.InvestigationConfigurationDetails details)` Creates an investigation configuration record.
`void`	`createIssueConfiguration(curam.core.facade.struct.IssueConfigurationDetails details)` Creates a new issue configuration record.
`void`	`createIssueTimeConstraint(curam.core.sl.entity.struct.IssueTimeConstraintDtls details)` Creates a new issue time constraint record.
`void`	`createLiabilityProduct1(curam.core.facade.struct.LiabilityProductDetails1 details)` Creates a liability product.
`void`	`createMilestoneConfiguration(curam.core.facade.struct.MilestoneConfigurationDtls details)` Creates a new milestone configuration record.
`void`	`createMilestoneForCaseType(curam.core.sl.struct.CaseTypeIDAndType key, curam.core.facade.struct.MilestoneConfigurationDtls details)` This method helps to create a Milestone for a Case Type with the details provided by the user.
`void`	`createMultipleTemporalEvApprovalCheck(curam.core.facade.struct.PercentageAndCommentsDetails details, curam.core.facade.struct.EvidenceListDetails evidenceList)` Creates a Temporal Evidence Approval Check for each evidence type specified.
`curam.core.facade.struct.PDAssessmentConfigurationKey`	`createPDAssessmentConfiguration(curam.core.facade.struct.CreatePDAssessmentConfigurationDetails dtls)` This method creates the association between a product and assessment.
`void`	`createProductApprovalCheck(curam.core.facade.struct.ProductApprovalCheckDetails details)` Creates an approval check for a product.
`void`	`createProductEvidenceFormLink(curam.core.facade.struct.CreateProductEvidenceFormLinkDetails details)` Creates a link between an evidence form and a product.
`void`	`createProductEvidenceLink(curam.core.facade.struct.ProductEvidenceLinkDetails details)` Creates a Product Evidence Link record.
`void`	`createProductProvision(curam.core.facade.struct.ProductCreateProductProvisionDetails details)` Creates a new product provision record.
`void`	`createProductTimeConstraint(curam.core.facade.struct.CreateProductTimeConstraint dtls)` Presentation layer method to create a product time constraint record.
`void`	`createProvisionLocation(curam.core.facade.struct.CreateProvisionLocationDetails details)` Assigns a Product Provider to a Product Location by inserting a Product Provision Location.
`void`	`createResolutionApprovalCheckForIssue(curam.core.facade.struct.IssueResolutionApprovalCheckDetails issueResolutionApprovalCheckDetails)` This method allows an administrator to configure an approval check for a particular issue.
`void`	`createResolutionConfiguration(curam.core.facade.struct.ResolutionConfigurationDtls details)` Creates resolution configuration details.
`void`	`createResolutionForInvestigation(curam.core.sl.entity.struct.InvestigationResolutionLinkDtls details)` Creates a new resolution for an investigation.
`void`	`createResolutionForIssue(curam.core.facade.struct.IssueResolutionLinkDtls details)` Creates a new resolution and also associates that resolution with an issue.
`void`	`createSiteMap(curam.core.facade.struct.CreateSiteMapDetails details)` Creates a new Site Map on a specified Product.
`void`	`deleteAbsenceReasonConfiguration(curam.core.facade.struct.VersionNo versionNo, curam.attendance.entity.struct.AbsenceReasonConfigurationKey key)` Deletes the absence reason configuration record.
`void`	`deletePDAssessmentConfiguration(curam.core.facade.struct.CancelPDAssessmentConfigurationDetails dtls)` This method cancels the association between an product and assessment configuration.
`void`	`deleteProductEvidenceLink(curam.core.sl.infrastructure.struct.ProductEvidenceLinkAndEvidenceTypeKey key)` Deletes (physically) a Product Evidence Link record.
`curam.core.facade.struct.MilestoneComponentList`	`getComponentList(curam.core.facade.struct.ComponentBaseType key)` Returns a list of components based on the incoming code value.
`curam.core.facade.struct.ProductDefaultValuesDetails`	`getProductDefaultValues()` Method to return default values for product to be created.
`curam.core.facade.struct.ResolutionContextDescription`	`getResolutionContextDescription(curam.core.sl.entity.struct.ResolutionConfigurationKey key)` Reads the resolution code table type.
`curam.core.facade.struct.MilestoneSubComponentList`	`getSubComponentList(curam.core.facade.struct.ComponentType key)` Returns a list of sub components based on the component code.
`curam.core.facade.struct.AbsenceReasonConfigurationDetailsList`	`listAbsenceReasonConfiguration(curam.core.facade.struct.AssociateIDKey key)` Returns a list of active absence reason configuration records.
`curam.core.facade.struct.ListActiveBenefitProductsForPersonDetails`	`listActiveBenefitProductsForPerson(curam.core.facade.struct.ListActiveBenefitProductsForPersonKey key)` Returns a list of active benefit products for a person.
`curam.core.facade.struct.ListActiveEvidenceFormsDetails`	`listActiveEvidenceForms()` Returns a list of all available active evidence forms.
`curam.core.sl.entity.struct.InvestigationIDTypeDtlsList`	`listActiveInvestigationTypes()` Returns all current active investigation type details.
`curam.core.facade.struct.IssueTypeDescriptionDetailsList`	`listActiveIssueTypes()` Returns all active issue type details.
`curam.core.facade.struct.ListAdhocBonusCriteriaDetails`	`listAdhocBonusCriteria(curam.core.facade.struct.ListAdhocBonusCriteriaKey key)` Returns a list of ad hoc bonus criteria.
`curam.core.facade.struct.BenefitProductTypeList`	`listAllBenefitProductTypes()` Method to list all benefit product types.
`curam.core.facade.struct.ListProductDeliveryPatternDetails`	`listAllDeliveryPatterns(curam.core.facade.struct.ListDeliveryPatternKey key)` This method is intended to be used by a user to list all delivery patterns.
`curam.core.facade.struct.ListProductDetailsStruct`	`listAllEnabledLiabilityProducts()` This method returns a list of all enabled liability products.
`curam.core.facade.struct.InvestigationConfigurationListDetails`	`listAllInvestigationConfigurations()` Returns all active or canceled investigation configuration records ordered by record status and start date.
`curam.core.facade.struct.IssueConfigurationDetailsList`	`listAllIssueConfigurations()` Returns all active or canceled issue configuration records ordered by record status and start date.
`curam.core.facade.struct.IssueConfigTypeList`	`listAllIssueTypes()` Method to list all issue types.
`curam.core.facade.struct.LiabilityProductTypeList`	`listAllLiabilityProductTypes()` Method to list all liability product types.
`curam.core.facade.struct.MilestoneConfigurationDtlsList`	`listAllMilestoneConfigurations()` Returns a list of milestone configurations.
`curam.core.facade.struct.ListAllProductsDetails`	`listAllProducts()` Lists all products recorded in the application.
`curam.core.facade.struct.ListAllProviderLocations`	`listAllProviderLocations(curam.core.facade.struct.ProductProvisionKey key)` Returns a list of all provider locations.
`curam.core.facade.struct.ListInvestigationApprovalCheckDetails`	`listApprovalCheckForInvestigation(curam.core.sl.entity.struct.InvestigationConfigKey key)` This method lists all existing approval checks for a particular investigation.
`curam.core.facade.struct.ListInvestigationApprovalCheckDetailsAndVersionNo`	`listApprovalCheckForInvestigationAndVersionNo(curam.core.sl.entity.struct.InvestigationConfigKey key)` This method lists all existing approval checks for a particular investigation.
`curam.core.facade.struct.ListApprovalChecksForProductDetails`	`listApprovalChecksForProduct(curam.core.facade.struct.ListApprovalChecksForProductKey key)` Returns a list of approval checks for a particular product.
`curam.core.facade.struct.PDAssessmentConfigurationSummaryDetailsList`	`listAssessmentConfigsForProduct(curam.core.struct.ProductKey key)` This method list of all assessments associated to a product.
`curam.core.facade.struct.PDAssessmentConfigurationSummaryDetailsListAndVersionNo`	`listAssessmentConfigsForProductAndVersionNo(curam.core.struct.ProductKey key)` This method list of all assessments associated to a product.
`curam.core.sl.struct.MilestoneConfigurationLinkDetailsList`	`listAssociatedMilestones(curam.core.struct.ProductKey productKey)` This method is intended to be used by user to list all the milestones which are currently associated with a particular product.
`curam.core.struct.ProductSummaryDetailsList`	`listBenefitProducts()` Returns a list of the benefit products.
`curam.core.facade.struct.ListProductDetailsStruct`	`listBenefitProductsForTypePerson()` Returns a list of benefit products.
`curam.core.struct.ProductSummaryDetailsList`	`listCorrectionProducts()` Returns a list of the correction products.
`curam.core.facade.struct.EvidenceMetadataDetailsList`	`listCurrentActiveEvidenceMetadata(curam.core.struct.ProductKey productID)` Returns a list of currently active Evidence Metadata details.
`curam.core.facade.struct.DeductionProductLinkDetailsList`	`listDeduction(curam.core.struct.ProductKey key)`
`curam.core.facade.struct.DeductionProductLinkWithVersionNoDetailsList`	`listDeductionWithVersionNo(curam.core.struct.ProductKey key)` Returns a list of deductions for a product.
`curam.core.facade.struct.ListDeliveryPatternHistoryDetails`	`listDeliveryPatternHistory(curam.core.facade.struct.ListDeliveryPatternHistoryKey key)` Returns a list of delivery patterns by productDeliveryPatternID.
`curam.core.facade.struct.ListDeliveryPatternNameDetails`	`listDeliveryPatternNames(curam.core.facade.struct.ListDeliveryPatternNamesKey key)` Returns a list of delivery pattern names.
`curam.core.facade.struct.DeliveryPatternNamePrefMethodPmtIndDtlsList1`	`listDeliveryPatternPreferredMethodOfPayment1(curam.core.facade.struct.ProductIDAndConcernRoleID key)` Returns a list of delivery pattern names and a curam indicator to show concern Preferred Delivery Method.
`curam.core.facade.struct.AssessmentConfigurationIDAndNameDetailsList`	`listDistinctPDAssessmentConfigurationByCaseID(curam.core.facade.struct.ListAssessmentTypesForPDCaseIDKey key)` This method list all the distinct assessment for the product delivery
`curam.core.facade.struct.ListEvidenceApprovalCheckDetails`	`listEvidenceApprovalCheck(curam.core.facade.struct.ListEvidenceApprovalCheckKey key)` Returns a list of evidence approval checks for the product.
`curam.core.facade.struct.ListEvidenceFormsForProductDetails`	`listEvidenceFormsForProduct(curam.core.facade.struct.ListEvidenceFormsForProductKey key)` List all evidence forms for a particular product.
`curam.core.facade.struct.ListEvidenceGroupPageDetails`	`listEvidenceGroupPage(curam.core.facade.struct.ListEvidenceGroupPageKey key)` Returns a list of Evidence Group Pages for a specified Product.
`curam.core.facade.struct.EvidenceMetadataDetailsList`	`listEvidenceMetadata()` Returns a list of Evidence Metadata details.
`curam.core.facade.struct.ListEvidencePageDetails`	`listEvidencePage(curam.core.facade.struct.ListEvidencePageKey key)` Returns a list of Evidence Pages for a specified Product.
`curam.core.facade.struct.EvidenceTypeList`	`listEvidenceTypesByCaseID(curam.core.struct.CaseID key)` Retrieves a list of all evidence types associated with the type of product for a specified case.
`curam.core.facade.struct.EvidenceTypeList`	`listEvidenceTypesByProductID(curam.core.sl.infrastructure.entity.struct.ProductIDAndRecordStatusKey key)` Lists evidence types that are related to a specified product.
`curam.core.sl.infrastructure.struct.EvidenceTypeList`	`listEvidenceTypesForCreateByProductID(curam.core.struct.ProductKey key)` Returns a list of evidence types that can be used to create a Temporal Evidence Approval Check entry related to a product.
`curam.core.facade.struct.IssueTimeConstraintList`	`listIssueTimeConstraint(curam.core.sl.entity.struct.IssueConfigurationKey key)` Returns a list of issue time constraint records for a specified issue type.
`curam.core.struct.ProductSummaryDetailsList`	`listLiabilityProducts()` Returns a list of the liability products.
`curam.core.facade.struct.ListProductDetailsStruct`	`listLiabilityProductsForTypePerson()` Returns a list of liability products.
`curam.workspaceservices.facade.struct.ViewLocalizableTextDetails`	`listLocalizableDeliveryPatternCommentsText(curam.workspaceservices.facade.struct.LocalizableTextDetails details)` This method is intended to be used by users to list localizable translations of DeliverPattern Comments.
`curam.workspaceservices.facade.struct.ViewLocalizableTextDetails`	`listLocalizableDeliveryPatternNameText(curam.workspaceservices.facade.struct.LocalizableTextDetails localizableTextDetails)` This method is intended to be used by users to list localizable translations of DeliverPattern name.
`curam.workspaceservices.facade.struct.ViewLocalizableTextDetails`	`listLocalizableMilestoneCommentsText(curam.workspaceservices.facade.struct.LocalizableTextDetails details)` This method is intended to be used by users to list localizable translations of Milestone Comments.
`curam.workspaceservices.facade.struct.ViewLocalizableTextDetails`	`listLocalizableMilestoneNameText(curam.workspaceservices.facade.struct.LocalizableTextDetails details)` This method is intended to be used by users to list localizable translations of Milestone name.
`curam.workspaceservices.facade.struct.ViewLocalizableTextDetails`	`listLocalizableMilestoneTypeText(curam.workspaceservices.facade.struct.LocalizableTextDetails details)` This method is intended to be used by users to list localizable translations of Milestone type.
`curam.core.facade.struct.ListLocationForProviderDetails`	`listLocationForProvider(curam.core.facade.struct.ListLocationForProviderKey key)` This method exists for customers to implement using sub classing with replacement.
`curam.core.sl.struct.MilestoneConfigurationLinkDetailsList`	`listMilestoneConfigurationsForCaseType(curam.core.sl.struct.CaseTypeIDAndType key)` This method ins intended to be used by users to list all the Milestone configuration details of a particular Case Type ID and Case Type
`curam.core.facade.struct.ListAssessmentTypesForPDCaseIDListDetails`	`listPDAssessmentConfigurationByCaseID(curam.core.facade.struct.ListAssessmentTypesForPDCaseIDKey key)` This method list all assessment configuration for a product delivery case.
`curam.core.facade.struct.ListProductCategoryDetails`	`listProductCategory(curam.core.facade.struct.ListProductCategoryKey key)` Returns a list of categories for which a product is associated and a list of categories for which the product is not associated.
`curam.core.facade.struct.ProductEvidenceTypeDetails`	`listProductEvidenceLink(curam.core.struct.ProductKey key)` Returns a list of Product Evidence Link details.
`curam.core.facade.struct.ListProductProvisionsForProduct`	`listProductProvisionsForProduct(curam.core.facade.struct.ListProductProvisionsForProductKey key)` Returns a list of product provision details for a specified product.
`curam.core.facade.struct.ListProductDetailsStruct`	`listProductsForCategory(curam.core.facade.struct.ListProductsForCategoryKey key)` Returns a list of products of a particular product category.
`curam.core.facade.struct.ListProductDetailsStruct`	`listProductsForCategoryAndPerson(curam.core.facade.struct.ListProductsForCategoryKey key)` Returns a filtered list of products for those products only applicable to concern roles of type Person.
`curam.core.facade.struct.SecurityIDList`	`listProductSIDs()` Returns a list of security identifiers of type Product.
`curam.core.facade.struct.ProductNameList`	`listProductsSharingEvidence(curam.core.sl.infrastructure.entity.struct.ProductIDEvidenceTypeAndRecStatusKey key)` Returns a list of products which share evidence with the specified product.
`curam.core.facade.struct.ListProductTimeConstraint`	`listProductTimeConstaint(curam.core.facade.struct.ReadProductTimeConstraintRMKey key)` Presentation layer method to return a list of product time constraint records.
`curam.core.facade.struct.ListProductTimeConstraintAndVersionNo`	`listProductTimeConstaintAndVersionNo(curam.core.facade.struct.ReadProductTimeConstraintRMKey key)` Presentation layer method to return a list of product time constraint records.
`curam.core.facade.struct.ListProviderAndLocationDetails`	`listProvidersAndLocations(curam.core.facade.struct.ListProviderAndLocationKey key)` Returns a list of product providers and their corresponding locations.
`curam.core.facade.struct.ListProvisionLocationDetails`	`listProvisionLocation(curam.core.facade.struct.ListProvisionLocationKey key)` Returns a list of product provision locations.
`curam.core.facade.struct.ListIssueResolutionApprovalCheckDetails`	`listResolutionApprovalCheckForIssue(curam.core.sl.entity.struct.IssueConfigurationKey listIssueResolutionApprovalCheckKey)` This method lists all existing approval checks for a particular issue.
`curam.core.facade.struct.ListIssueResolutionApprovalCheckDetailsAndVersionNo`	`listResolutionApprovalCheckForIssueAndVersionNo(curam.core.sl.entity.struct.IssueConfigurationKey listIssueResolutionApprovalCheckKey)` This method lists all existing approval checks for a particular issue.
`curam.core.facade.struct.ResolutionConfigurationDtlsList`	`listResolutionConfiguration()` Returns a list of resolution configurations.
`curam.core.sl.struct.InvestigationResLinkIDResolutionDtlsList`	`listResolutionsForInvestigation(curam.core.sl.entity.struct.InvestigationConfigKey key)` Returns a list resolutions already associated with a selected investigation.
`curam.core.facade.struct.IssueResLinkIDResolutionDtlsList`	`listResolutionsForIssue(curam.core.sl.entity.struct.IssueConfigurationKey key)` Returns a list resolutions already associated with a selected issue type.
`curam.core.facade.struct.ListRulesForProductDetails`	`listRulesForProduct(curam.core.facade.struct.ListRulesForProductKey key)` Returns a list of available RuleSets for a particular product.
`curam.core.facade.struct.ListRulesForProductDetailsAndVersionNo`	`listRulesForProductAndVersionNo(curam.core.facade.struct.ListRulesForProductKey key)` Returns a list of available RuleSets for a particular product.
`curam.core.facade.struct.ListRulesObjectiveDetails`	`listRulesObjective(curam.core.facade.struct.ListRulesObjectiveKey key)` Returns a list of rules objectives.
`curam.core.facade.struct.ListRulesObjectiveTagDetails`	`listRulesObjectiveTag(curam.core.facade.struct.ListRulesObjectiveTagKey key)` Returns a list of rules objective tags.
`curam.core.facade.struct.ListSiteMapDetails`	`listSiteMap(curam.core.facade.struct.ListSiteMapKey key)` Returns a list of Site Maps for a specified Product.
`curam.core.facade.struct.TemporalEvidenceApprovalCheckList`	`listTemporalEvApprovalCheckByProductID(curam.core.sl.infrastructure.entity.struct.ProdIDRecStatusAndApprovTypeKey key)` Returns a list of Temporal Evidence Approval Checks that are related to a specified product.
`curam.core.facade.struct.ResolutionConfigurationDtlsList`	`listUnassignedResolutionDetails(curam.core.sl.entity.struct.IssueConfigurationKey key)` Returns a list of resolutions not associated with an issue.
`curam.core.facade.struct.ResolutionConfigurationDtlsList`	`listUnassignedResolutionDetailsForInvestigation(curam.core.sl.entity.struct.InvestigationConfigKey key)` Returns a list of the investigation resolutions that are not associated with an investigation.
`curam.core.facade.struct.UnassociatedDeductionDetailsList`	`listUnassociatedDeduction(curam.core.struct.ProductKey key)` Returns a list of deductions not associated with a product.
`curam.core.sl.struct.MilestoneConfigurationSummaryDtlsList`	`listUnassociatedMilestone(curam.core.struct.ProductKey productKey)` Lists all the active milestones not already associated with a particular product.
`curam.core.sl.struct.MilestoneConfigurationSummaryDtlsList`	`listUnassociatedMilestoneForProductIDCaseType(curam.core.facade.struct.ProductMilestoneLinkKey key)` Lists unassociated milestones for a product id and case type.
`void`	`modifyAbsenceReasonConfiguration(curam.attendance.entity.struct.AbsenceReasonConfigurationDtls dtls)` Modify an Absence Reason Configuration record.
`void`	`modifyAdhocBonusCriteria(curam.core.facade.struct.ModifyAdhocBonusCriteriaDetails details)` Modifies the details of an ad hoc bonus criteria record.
`void`	`modifyApprovalCheckForInvestigation(curam.core.facade.struct.InvestigationApprovalCheckDetails details)` This method allows an administrator to modify an Investigation Approval Check for a particular investigation.
`void`	`modifyBenefitProduct1(curam.core.struct.ProductKeyStruct key, curam.core.facade.struct.BenefitProductDetails1 details)` Modifies details of a benefit product.
`void`	`modifyCorrection(curam.core.facade.struct.CorrectionProductDetails details)` Modifies details of a payment correction product.
`void`	`modifyDeduction(curam.core.facade.struct.ModifyProductDeductionDetails details)` Modifies the deduction product link record.
`void`	`modifyDeductionPriority(curam.core.facade.struct.ModifyDeductionPriorityDetails details)` Deprecated. Since Curam 6.0 SP2, replaced by modifyDeduction. Modifies the priority for a deduction product link record.
`void`	`modifyDeliveryPattern(curam.core.facade.struct.ModifyDeliverPatternDetails details)` Deprecated. since curam 6.0 , replaced by `Product#modifyProductDeliveryPattern()` See release note: CR00235829. Modifies details of a delivery pattern.
`void`	`modifyDeliveryPatternCommentsTextTranslation(curam.workspaceservices.facade.struct.LocalizableTextDetails details)` This method is indented to be used by users who modify localizable text translations of DeliverPattern Comments.
`void`	`modifyEvidenceApprovalCheck(curam.core.facade.struct.EvidenceApprovalCheckDtls details)` Modifies details of an evidence approval check.
`void`	`modifyEvidenceGroupPage(curam.core.facade.struct.ModifyEvidenceGroupPageDetails details)` Modifies Evidence Group Page details for a specified Product.
`void`	`modifyEvidenceMetadata(curam.core.facade.struct.EvidenceMetadataDetails details)` Modifies Evidence Metadata details.
`void`	`modifyEvidencePage(curam.core.facade.struct.ModifyEvidencePageDetails details)` Modifies Evidence Page details for a specified Product.
`void`	`modifyInvestigationConfiguration(curam.core.facade.struct.InvestigationConfigurationDetails details)` Modifies an existing investigation configuration record.
`void`	`modifyIssueConfiguration(curam.core.facade.struct.IssueConfigurationDetails details)` Modifies an existing issue configuration record.
`void`	`modifyIssueTimeConstraint(curam.core.sl.entity.struct.IssueTimeConstraintDtls details)` Modifies an existing active issue time constraint record.
`void`	`modifyLiabilityProduct1(curam.core.struct.ProductKeyStruct key, curam.core.facade.struct.LiabilityProductDetails1 details)` Modifies the details of a liability product.
`void`	`modifyMilestoneCommentsTextTranslation(curam.workspaceservices.facade.struct.LocalizableTextDetails details)` This method is indented to be used by users who modify localizable text translations of Milestone Comments.
`void`	`modifyMilestoneConfiguration(curam.core.facade.struct.MilestoneConfigurationDtls details)` Modifies an existing milestone configuration record.
`void`	`modifyMilestoneLinkAssociation(curam.core.sl.entity.struct.MilestoneLinkKey key, curam.core.sl.struct.MilestoneLinkConfigDetails details)` This method allows the milestone association details such as component category, component type creation event and completion event to be modified.
`void`	`modifyMilestoneNameTextTranslation(curam.workspaceservices.facade.struct.LocalizableTextDetails details)` This method is indented to be used by users who modify localizable text translations of Milestone Name.
`void`	`modifyMilestoneTypeTextTranslation(curam.workspaceservices.facade.struct.LocalizableTextDetails details)` This method is indented to be used by users who modify localizable text translations of Milestone Type.
`void`	`modifyPDAssessmentConfiguration(curam.core.facade.struct.ModifyPDAssessmentConfigurationDetails dtls)` This method modifies the association between an product and assessment configuration.
`void`	`modifyProductApprovalCheck(curam.core.facade.struct.ProductApprovalCheckDetails details)` Modifies details of a product approval check.
`void`	`modifyProductDeliveryPattern(curam.core.facade.struct.ModifyProductDeliveryPatternDetails details)` Deprecated. Since Curam 6.0 SP2, replaced by `Product#modifyProductDeliveryPatternInfo()` The existing method, modifyProductDeliveryPattern, does not support the display of informational message to be shown when the offset does not have an effect on delivery pattern. Hence the new method modifyProductDeliveryPatternInfo has been created, which will validate the offset against a delivery pattern and returns the informational message. See release note: CEF-8154
`curam.core.struct.InformationalMsgDtlsList`	`modifyProductDeliveryPatternInfo(curam.core.facade.struct.ModifyProductDeliveryPatternDetails details)` This method is intended to be used by users responsible for administrating product delivery pattern.It is used to modify the product delivery pattern.
`void`	`modifyProductEvidenceFormLink(curam.core.facade.struct.ModifyProductEvidenceFormLinkDetails details)` Modifies details of a product evidence form link.
`void`	`modifyProductProvision(curam.core.facade.struct.ProductProvisionKey key, curam.core.facade.struct.ModifyProductProvisionDetails details)` Modifies details of a product provision.
`void`	`modifyProductTimeConstraint(curam.core.facade.struct.ModifyProductTimeConstraint dtls)` Presentation layer method to modify a product time constraint record.
`void`	`modifyProvisionLocation(curam.core.facade.struct.ModifyProvisionLocationKey key, curam.core.facade.struct.ModifyProvisionLocationDetails details)` Modifies details of a product provision location.
`void`	`modifyResolutionApprovalCheckForIssue(curam.core.facade.struct.IssueResolutionApprovalCheckDetails issueResolutionApprovalCheckDetails)` This method allows an administrator to modify an Issue Resolution Approval Check for a particular issue.
`void`	`modifyResolutionConfiguration(curam.core.facade.struct.ResolutionConfigurationDtls details)` Modifies an existing resolution configuration record.
`void`	`modifyRuleSetAssignmentDetails(curam.core.facade.struct.ModifyRuleSetAssignmentDetails details)` Modifies the details of an existing rule set assignment to a product.
`void`	`modifySiteMap(curam.core.facade.struct.ModifySiteMapDetails details)` Modifies Site Map details on a specified Product.
`void`	`modifyTemporalEvidenceApprovalCheck(curam.core.facade.struct.ModifyTemporalEvidenceApprovalCheck details)` Modifies details of a single Temporal Evidence Approval Check.
`curam.attendance.entity.struct.AbsenceReasonConfigurationDtls`	`readAbsenceReasonConfiguration(curam.attendance.entity.struct.AbsenceReasonConfigurationKey key)` Reads an Absence reason configuration details.
`curam.core.facade.struct.ReadAdhocBonusCriteriaDetails`	`readAdhocBonusCriteria(curam.core.facade.struct.ReadAdhocBonusCriteriaKey key)` Reads ad hoc bonus criteria details.
`curam.core.facade.struct.ReadInvestigationApprovalCheckDetails`	`readApprovalCheckForInvestigation(curam.core.facade.struct.ReadInvestigationApprovalCheckKey key)` This method allows an administrator to view an approval check for a particular investigation.
`curam.core.facade.struct.ReadBenefitProductStruct1`	`readBenefitProduct1(curam.core.facade.struct.ReadBenefitProductKey key)` Reads details of a benefit product.
`curam.core.facade.struct.CorrectionProductDetails`	`readCorrection(curam.core.facade.struct.ReadBenefitProductKey key)` Reads details of a payment correction product.
`curam.core.facade.struct.ReadDeductionDtls`	`readDeduction(curam.core.facade.struct.DeductionProductLinkKey key)` Retrieves the details for a specified Product Deduction record.
`curam.workspaceservices.facade.struct.TextTranslationDetails`	`readDeliveryPatternCommentsTextTranslation(curam.workspaceservices.facade.struct.LocalizableTextDetails details)` This method is indented to be used by users to read localizable text translation of DeliverPattern Comments.
`curam.workspaceservices.facade.struct.TextTranslationDetails`	`readDeliveryPatternNameTextTranslation(curam.workspaceservices.facade.struct.LocalizableTextDetails localizableTextDetails)` This method is indented to be used by users to read localizable text translation of DeliverPattern name.
`curam.core.facade.struct.ReadEvidenceApprovalCheckDetails`	`readEvidenceApprovalCheck(curam.core.facade.struct.ReadEvidenceApprovalCheckKey key)` Reads details of an evidence approval check.
`curam.core.facade.struct.ReadEvidenceGroupPageDetails`	`readEvidenceGroupPage(curam.core.facade.struct.ReadEvidenceGroupPageKey key)` Returns details of an Evidence Group Page for a specific Product.
`curam.core.facade.struct.EvidenceMetadataDetails`	`readEvidenceMetadata(curam.core.sl.infrastructure.entity.struct.EvidenceMetadataKey key)` Reads Evidence Metadata details.
`curam.core.facade.struct.ReadEvidencePageDetails`	`readEvidencePage(curam.core.facade.struct.ReadEvidencePageKey key)` Returns details of an Evidence Page for a specific Product.
`curam.core.facade.struct.InvestigationConfigurationDetails`	`readInvestigationConfiguration(curam.core.sl.entity.struct.InvestigationConfigKey key)` Returns the details for an investigation configuration record.
`curam.core.facade.struct.IssueConfigurationDetails`	`readIssueConfiguration(curam.core.sl.entity.struct.IssueConfigurationKey key)` Returns the details for an issue configuration record.
`curam.core.sl.entity.struct.IssueTimeConstraintDtls`	`readIssueTimeConstraint(curam.core.sl.entity.struct.IssueTimeConstraintKey key)` Reads details of an issue time constraint record.
`curam.core.facade.struct.ReadLiabilityProductStruct`	`readLiabilityProduct(curam.core.struct.ProductKeyStruct key)` Deprecated. by readLiabilityProduct1. Reads details of a liability product.
`curam.core.facade.struct.ReadLiabilityProductStruct1`	`readLiabilityProduct1(curam.core.struct.ProductKeyStruct key)` Reads details of a liability product.
`curam.workspaceservices.facade.struct.TextTranslationDetails`	`readMilestoneCommentsTextTranslation(curam.workspaceservices.facade.struct.LocalizableTextDetails details)` This method is indented to be used by users to read localizable text translation of Milestone comments.
`curam.core.facade.struct.MilestoneConfigurationDtls`	`readMilestoneConfiguration(curam.core.sl.entity.struct.MilestoneConfigurationKey key)` Returns the details for a milestone configuration record.
`curam.core.sl.struct.MilestoneLinkAssociatedInfo`	`readMilestoneConfigurationLink(curam.core.sl.entity.struct.MilestoneLinkKey key)` Returns milestone link details based on the milestone link id.
`curam.workspaceservices.facade.struct.TextTranslationDetails`	`readMilestoneNameTextTranslation(curam.workspaceservices.facade.struct.LocalizableTextDetails details)` This method is indented to be used by users to read localizable text translation of Milestone name.
`curam.workspaceservices.facade.struct.TextTranslationDetails`	`readMilestoneTypeTextTranslation(curam.workspaceservices.facade.struct.LocalizableTextDetails details)` This method is indented to be used by users to read localizable text translation of Milestone Type.
`curam.core.facade.struct.ReadModifyDeductionPriorityDetails`	`readModifyDeductionDetails(curam.core.facade.struct.DeductionProductLinkKey key)` Reads deduction details to modify deduction priority.
`curam.core.facade.struct.PDAssessmentConfigurationDetails`	`readPDAssessmentConfiguration(curam.core.facade.struct.PDAssessmentConfigurationKey key)` This method reads the details of the association between product and assessment.
`curam.core.facade.struct.ReadProductApprovalCheckDetails`	`readProductApprovalCheck(curam.core.facade.struct.ReadProductApprovalCheckKey key)` Reads details of a product approval check.
`curam.core.facade.struct.ReadProductDeliveryPatternDetails`	`readProductDeliveryPattern(curam.core.facade.struct.ReadDeliveryPatternKey key)` This method is intended to be used by user to reads details of a delivery pattern.
`curam.core.facade.struct.ReadProductEvidenceFormDetails`	`readProductEvidenceFormLink(curam.core.facade.struct.ReadProductEvidenceFormKey key)` Reads details of a product evidence form link.
`curam.core.facade.struct.ReadProductProvisionDetails`	`readProductProvision(curam.core.facade.struct.ProductProvisionKey key)` Reads details of a product provision.
`curam.core.facade.struct.ReadProductTimeConstraint`	`readProductTimeConstraint(curam.core.facade.struct.ProductTimeConstraintKey key)` Presentation layer method to read product time constraint record.
`curam.core.struct.ProductTypeCodeIn`	`readProductTypeByProductID(curam.core.struct.ProductKeyStruct key)` Returns a list of products which share evidence with the specified product.
`curam.core.facade.struct.ReadProvisionLocationDetails`	`readProvisionLocation(curam.core.facade.struct.ReadProvisionLocationKey key)` Reads details of a product provision location.
`curam.core.facade.struct.ReadIssueResolutionApprovalCheckDetails`	`readResolutionApprovalCheckForIssue(curam.core.facade.struct.ReadIssueResolutionApprovalCheckKey readIssueResolutionApprovalCheckKey)` This method allows an administrator to view a resolution approval check for a particular issue.
`curam.core.facade.struct.ResolutionConfigurationDtls`	`readResolutionConfiguration(curam.core.sl.entity.struct.ResolutionConfigurationKey key)` Reads an existing Issue Resolution record.
`void`	`readRuleSet()` Read details on a specific ruleSet.
`curam.core.facade.struct.ReadRuleSetAssignmentDetails`	`readRuleSetAssignmentDetails(curam.core.facade.struct.ReadRuleSetAssignmentDetailsKey key)` Reads an assignment link between products and rules.
`curam.core.facade.struct.RulesObjectiveDetails`	`readRulesObjective(curam.core.facade.struct.ReadRulesObjectiveKey key)` Reads details on a rules objective.
`curam.core.facade.struct.ReadRulesObjectiveTagDetails`	`readRulesObjectiveTag(curam.core.facade.struct.ReadRulesObjectiveTagKey key)` Reads details on a rules objective tag.
`curam.core.facade.struct.ReadSiteMapDetails`	`readSiteMap(curam.core.facade.struct.ReadSiteMapKey key)` Returns details of a Site Map for a specific Product.
`curam.core.facade.struct.ViewTemporalEvidenceApprovalCheck`	`readTemporalEvidenceApprovalCheck(curam.core.facade.struct.TemporalEvidenceApprovalCheckKey key)` Reads details of a single Temporal Evidence Approval Check entry.
`void`	`removeCategoryFromProduct(curam.core.facade.struct.RemoveCategoryFromProductKey key)` Removes a product category from a product.
`void`	`removeDeduction(curam.core.facade.struct.DeductionProductLinkKey key)` Removes a deduction product link record.
`void`	`removeMilestone(curam.core.sl.entity.struct.MilestoneLinkKey key)` Removes the link between a milestone and a product.
`void`	`removeResolutionConfiguration(curam.core.sl.entity.struct.ResolutionConfigurationKey key)` Removes a resolution configuration record.
`curam.core.facade.struct.ParticipantHomePageName`	`resolveMemberHome(curam.core.facade.struct.ConcernRoleKeyStruct key)` Resolves the home page for person and prospect person.
`void`	`setAsDefaultDeliveryPattern(curam.core.facade.struct.SetAsDefaultDeliveryPatternKey key)` Presentation layer operation to set a delivery pattern as the default.

Method Detail

listProductProvisionsForProduct

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListProductProvisionsForProduct listProductProvisionsForProduct(curam.core.facade.struct.ListProductProvisionsForProductKey key)
                                                                                                               throws curam.util.exception.AppException,
                                                                                                                      curam.util.exception.InformationalException

Returns a list of product provision details for a specified product.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

readProductProvision

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadProductProvisionDetails readProductProvision(curam.core.facade.struct.ProductProvisionKey key)
                                                                                                throws curam.util.exception.AppException,
                                                                                                       curam.util.exception.InformationalException

Reads details of a product provision.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

cancelProductProvision

@AccessLevel(value=EXTERNAL)
void cancelProductProvision(curam.core.facade.struct.CancelProductProvisionKey key)
                                                  throws curam.util.exception.AppException,
                                                         curam.util.exception.InformationalException

Cancels a product provision.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

modifyProductProvision

@AccessLevel(value=EXTERNAL)
void modifyProductProvision(curam.core.facade.struct.ProductProvisionKey key,
                                                         curam.core.facade.struct.ModifyProductProvisionDetails details)
                                                  throws curam.util.exception.AppException,
                                                         curam.util.exception.InformationalException

Modifies details of a product provision.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listProvisionLocation

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListProvisionLocationDetails listProvisionLocation(curam.core.facade.struct.ListProvisionLocationKey key)
                                                                                                  throws curam.util.exception.AppException,
                                                                                                         curam.util.exception.InformationalException

Returns a list of product provision locations.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

readProvisionLocation

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadProvisionLocationDetails readProvisionLocation(curam.core.facade.struct.ReadProvisionLocationKey key)
                                                                                                  throws curam.util.exception.AppException,
                                                                                                         curam.util.exception.InformationalException

Reads details of a product provision location.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

cancelProvisionLocation

@AccessLevel(value=EXTERNAL)
void cancelProvisionLocation(curam.core.facade.struct.CancelProvisionLocationKey key)
                                                   throws curam.util.exception.AppException,
                                                          curam.util.exception.InformationalException

Cancels a provision location.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

modifyProvisionLocation

@AccessLevel(value=EXTERNAL)
void modifyProvisionLocation(curam.core.facade.struct.ModifyProvisionLocationKey key,
                                                          curam.core.facade.struct.ModifyProvisionLocationDetails details)
                                                   throws curam.util.exception.AppException,
                                                          curam.util.exception.InformationalException

Modifies details of a product provision location.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listRulesForProduct

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListRulesForProductDetails listRulesForProduct(curam.core.facade.struct.ListRulesForProductKey key)
                                                                                              throws curam.util.exception.AppException,
                                                                                                     curam.util.exception.InformationalException

Returns a list of available RuleSets for a particular product.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

cancelRuleSetFromProduct

@AccessLevel(value=EXTERNAL)
void cancelRuleSetFromProduct(curam.core.facade.struct.CancelRuleSetFromProductKey key)
                                                    throws curam.util.exception.AppException,
                                                           curam.util.exception.InformationalException

Cancels the assignment of a ruleSet to a product.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

readRuleSetAssignmentDetails

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadRuleSetAssignmentDetails readRuleSetAssignmentDetails(curam.core.facade.struct.ReadRuleSetAssignmentDetailsKey key)
                                                                                                         throws curam.util.exception.AppException,
                                                                                                                curam.util.exception.InformationalException

Reads an assignment link between products and rules.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

modifyRuleSetAssignmentDetails

@AccessLevel(value=EXTERNAL)
void modifyRuleSetAssignmentDetails(curam.core.facade.struct.ModifyRuleSetAssignmentDetails details)
                                                          throws curam.util.exception.AppException,
                                                                 curam.util.exception.InformationalException

Modifies the details of an existing rule set assignment to a product.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

assignRuleSetToProduct

@AccessLevel(value=EXTERNAL)
void assignRuleSetToProduct(curam.core.facade.struct.AssignRuleSetToProductDetails details)
                                                  throws curam.util.exception.AppException,
                                                         curam.util.exception.InformationalException

Assigns a ruleSet to a product.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

readRuleSet

@AccessLevel(value=EXTERNAL)
void readRuleSet()
                                       throws curam.util.exception.AppException,
                                              curam.util.exception.InformationalException

Read details on a specific ruleSet.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listRulesObjective

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListRulesObjectiveDetails listRulesObjective(curam.core.facade.struct.ListRulesObjectiveKey key)
                                                                                            throws curam.util.exception.AppException,
                                                                                                   curam.util.exception.InformationalException

Returns a list of rules objectives.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

readRulesObjective

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.RulesObjectiveDetails readRulesObjective(curam.core.facade.struct.ReadRulesObjectiveKey key)
                                                                                        throws curam.util.exception.AppException,
                                                                                               curam.util.exception.InformationalException

Reads details on a rules objective.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listRulesObjectiveTag

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListRulesObjectiveTagDetails listRulesObjectiveTag(curam.core.facade.struct.ListRulesObjectiveTagKey key)
                                                                                                  throws curam.util.exception.AppException,
                                                                                                         curam.util.exception.InformationalException

Returns a list of rules objective tags.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

readRulesObjectiveTag

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadRulesObjectiveTagDetails readRulesObjectiveTag(curam.core.facade.struct.ReadRulesObjectiveTagKey key)
                                                                                                  throws curam.util.exception.AppException,
                                                                                                         curam.util.exception.InformationalException

Reads details on a rules objective tag.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listApprovalChecksForProduct

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListApprovalChecksForProductDetails listApprovalChecksForProduct(curam.core.facade.struct.ListApprovalChecksForProductKey key)
                                                                                                                throws curam.util.exception.AppException,
                                                                                                                       curam.util.exception.InformationalException

Returns a list of approval checks for a particular product.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

createProductApprovalCheck

@AccessLevel(value=EXTERNAL)
void createProductApprovalCheck(curam.core.facade.struct.ProductApprovalCheckDetails details)
                                                      throws curam.util.exception.AppException,
                                                             curam.util.exception.InformationalException

Creates an approval check for a product.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

modifyProductApprovalCheck

@AccessLevel(value=EXTERNAL)
void modifyProductApprovalCheck(curam.core.facade.struct.ProductApprovalCheckDetails details)
                                                      throws curam.util.exception.AppException,
                                                             curam.util.exception.InformationalException

Modifies details of a product approval check.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

cancelProductApprovalCheck

@AccessLevel(value=EXTERNAL)
void cancelProductApprovalCheck(curam.core.facade.struct.CancelProductApprovalCheckKey key)
                                                      throws curam.util.exception.AppException,
                                                             curam.util.exception.InformationalException

Cancels a product approval check.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

readProductApprovalCheck

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadProductApprovalCheckDetails readProductApprovalCheck(curam.core.facade.struct.ReadProductApprovalCheckKey key)
                                                                                                        throws curam.util.exception.AppException,
                                                                                                               curam.util.exception.InformationalException

Reads details of a product approval check.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

createProductEvidenceFormLink

@AccessLevel(value=EXTERNAL)
void createProductEvidenceFormLink(curam.core.facade.struct.CreateProductEvidenceFormLinkDetails details)
                                                         throws curam.util.exception.AppException,
                                                                curam.util.exception.InformationalException

Creates a link between an evidence form and a product.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

modifyProductEvidenceFormLink

@AccessLevel(value=EXTERNAL)
void modifyProductEvidenceFormLink(curam.core.facade.struct.ModifyProductEvidenceFormLinkDetails details)
                                                         throws curam.util.exception.AppException,
                                                                curam.util.exception.InformationalException

Modifies details of a product evidence form link.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

cancelProductEvidenceFormLink

@AccessLevel(value=EXTERNAL)
void cancelProductEvidenceFormLink(curam.core.facade.struct.CancelProductEvidenceFormLinkKey key)
                                                         throws curam.util.exception.AppException,
                                                                curam.util.exception.InformationalException

Cancels a product evidence form link.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

readProductEvidenceFormLink

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadProductEvidenceFormDetails readProductEvidenceFormLink(curam.core.facade.struct.ReadProductEvidenceFormKey key)
                                                                                                          throws curam.util.exception.AppException,
                                                                                                                 curam.util.exception.InformationalException

Reads details of a product evidence form link.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listEvidenceFormsForProduct

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListEvidenceFormsForProductDetails listEvidenceFormsForProduct(curam.core.facade.struct.ListEvidenceFormsForProductKey key)
                                                                                                              throws curam.util.exception.AppException,
                                                                                                                     curam.util.exception.InformationalException

List all evidence forms for a particular product.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listActiveEvidenceForms

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListActiveEvidenceFormsDetails listActiveEvidenceForms()
                                                                                                      throws curam.util.exception.AppException,
                                                                                                             curam.util.exception.InformationalException

Returns a list of all available active evidence forms.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listEvidenceApprovalCheck

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListEvidenceApprovalCheckDetails listEvidenceApprovalCheck(curam.core.facade.struct.ListEvidenceApprovalCheckKey key)
                                                                                                          throws curam.util.exception.AppException,
                                                                                                                 curam.util.exception.InformationalException

Returns a list of evidence approval checks for the product.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

readEvidenceApprovalCheck

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadEvidenceApprovalCheckDetails readEvidenceApprovalCheck(curam.core.facade.struct.ReadEvidenceApprovalCheckKey key)
                                                                                                          throws curam.util.exception.AppException,
                                                                                                                 curam.util.exception.InformationalException

Reads details of an evidence approval check.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

modifyEvidenceApprovalCheck

@AccessLevel(value=EXTERNAL)
void modifyEvidenceApprovalCheck(curam.core.facade.struct.EvidenceApprovalCheckDtls details)
                                                       throws curam.util.exception.AppException,
                                                              curam.util.exception.InformationalException

Modifies details of an evidence approval check.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

createEvidenceApprovalCheck

@AccessLevel(value=EXTERNAL)
void createEvidenceApprovalCheck(curam.core.facade.struct.EvidenceApprovalCheckDtls details)
                                                       throws curam.util.exception.AppException,
                                                              curam.util.exception.InformationalException

Creates an evidence approval check.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

cancelEvidenceApprovalCheck

@AccessLevel(value=EXTERNAL)
void cancelEvidenceApprovalCheck(curam.core.facade.struct.CancelEvidenceApprovalCheckKey key)
                                                       throws curam.util.exception.AppException,
                                                              curam.util.exception.InformationalException

Cancels an evidence approval check.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

createAdhocBonusCriteria

@AccessLevel(value=EXTERNAL)
void createAdhocBonusCriteria(curam.core.facade.struct.CreateAdhocBonusCriteriaDetails details)
                                                    throws curam.util.exception.AppException,
                                                           curam.util.exception.InformationalException

Creates an ad hoc bonus criteria record on the system.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

modifyAdhocBonusCriteria

@AccessLevel(value=EXTERNAL)
void modifyAdhocBonusCriteria(curam.core.facade.struct.ModifyAdhocBonusCriteriaDetails details)
                                                    throws curam.util.exception.AppException,
                                                           curam.util.exception.InformationalException

Modifies the details of an ad hoc bonus criteria record.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listAdhocBonusCriteria

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListAdhocBonusCriteriaDetails listAdhocBonusCriteria(curam.core.facade.struct.ListAdhocBonusCriteriaKey key)
                                                                                                    throws curam.util.exception.AppException,
                                                                                                           curam.util.exception.InformationalException

Returns a list of ad hoc bonus criteria.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

cancelAdhocBonusCriteria

@AccessLevel(value=EXTERNAL)
void cancelAdhocBonusCriteria(curam.core.facade.struct.CancelAdhocBonusKey key)
                                                    throws curam.util.exception.AppException,
                                                           curam.util.exception.InformationalException

Cancel an ad hoc bonus criteria record.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

readAdhocBonusCriteria

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadAdhocBonusCriteriaDetails readAdhocBonusCriteria(curam.core.facade.struct.ReadAdhocBonusCriteriaKey key)
                                                                                                    throws curam.util.exception.AppException,
                                                                                                           curam.util.exception.InformationalException

Reads ad hoc bonus criteria details.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

modifyDeliveryPattern

@Deprecated
 @AccessLevel(value=EXTERNAL)
void modifyDeliveryPattern(curam.core.facade.struct.ModifyDeliverPatternDetails details)
                                                              throws curam.util.exception.AppException,
                                                                     curam.util.exception.InformationalException

Deprecated. since curam 6.0 , replaced by Product#modifyProductDeliveryPattern() See release note: CR00235829. Modifies details of a delivery pattern.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

cancelDeliveryPattern

@AccessLevel(value=EXTERNAL)
void cancelDeliveryPattern(curam.core.facade.struct.CancelDeliveryPatternKey key)
                                                 throws curam.util.exception.AppException,
                                                        curam.util.exception.InformationalException

Cancels a delivery pattern.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

createDeliveryPattern
```
@Deprecated
 @AccessLevel(value=EXTERNAL)
void createDeliveryPattern(curam.core.facade.struct.CreateDeliveryPatternDetails details)
                                                              throws curam.util.exception.AppException,
                                                                     curam.util.exception.InformationalException
```
Deprecated. Since Curam 6.0 SP2, replaced by Product#createDeliveryPatternInfo() The existing method,createDeliveryPattern, does not support the display of informational message to be shown when the offset does not have an effect on delivery pattern. Hence the new method createDeliveryPatternInfo has been created, which will validate the offset against a delivery pattern and returns the informational message. See release note: CEF-8154

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

cancelProduct

@AccessLevel(value=EXTERNAL)
void cancelProduct(curam.core.facade.struct.CancelProductKey key)
                                         throws curam.util.exception.AppException,
                                                curam.util.exception.InformationalException

Cancels a product.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

setAsDefaultDeliveryPattern

@AccessLevel(value=EXTERNAL)
void setAsDefaultDeliveryPattern(curam.core.facade.struct.SetAsDefaultDeliveryPatternKey key)
                                                       throws curam.util.exception.AppException,
                                                              curam.util.exception.InformationalException

Presentation layer operation to set a delivery pattern as the default.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listProductSIDs

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.SecurityIDList listProductSIDs()
                                                                              throws curam.util.exception.AppException,
                                                                                     curam.util.exception.InformationalException

Returns a list of security identifiers of type Product.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listDeliveryPatternHistory

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListDeliveryPatternHistoryDetails listDeliveryPatternHistory(curam.core.facade.struct.ListDeliveryPatternHistoryKey key)
                                                                                                            throws curam.util.exception.AppException,
                                                                                                                   curam.util.exception.InformationalException

Returns a list of delivery patterns by productDeliveryPatternID.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

createProvisionLocation

@AccessLevel(value=EXTERNAL)
void createProvisionLocation(curam.core.facade.struct.CreateProvisionLocationDetails details)
                                                   throws curam.util.exception.AppException,
                                                          curam.util.exception.InformationalException

Assigns a Product Provider to a Product Location by inserting a Product Provision Location. Called by an administrator.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listLocationForProvider

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListLocationForProviderDetails listLocationForProvider(curam.core.facade.struct.ListLocationForProviderKey key)
                                                                                                      throws curam.util.exception.AppException,
                                                                                                             curam.util.exception.InformationalException

This method exists for customers to implement using sub classing with replacement.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

addCategoriesToProduct

@AccessLevel(value=EXTERNAL)
void addCategoriesToProduct(curam.core.facade.struct.AddCategoriesToProductKey key)
                                                  throws curam.util.exception.AppException,
                                                         curam.util.exception.InformationalException

This method adds one or more product categories to a specified product. Called during processing when an administrator is configuring a product.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

removeCategoryFromProduct

@AccessLevel(value=EXTERNAL)
void removeCategoryFromProduct(curam.core.facade.struct.RemoveCategoryFromProductKey key)
                                                     throws curam.util.exception.AppException,
                                                            curam.util.exception.InformationalException

Removes a product category from a product. Called by an administration user.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listProductCategory

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListProductCategoryDetails listProductCategory(curam.core.facade.struct.ListProductCategoryKey key)
                                                                                              throws curam.util.exception.AppException,
                                                                                                     curam.util.exception.InformationalException

Returns a list of categories for which a product is associated and a list of categories for which the product is not associated. Called in the administration of Liability and Benefit products.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

readLiabilityProduct

@Deprecated
 @AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadLiabilityProductStruct readLiabilityProduct(curam.core.struct.ProductKeyStruct key)
                                                                                                            throws curam.util.exception.AppException,
                                                                                                                   curam.util.exception.InformationalException

Deprecated. by readLiabilityProduct1. Reads details of a liability product.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listAllProducts

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListAllProductsDetails listAllProducts()
                                                                                      throws curam.util.exception.AppException,
                                                                                             curam.util.exception.InformationalException

Lists all products recorded in the application. Called in administration.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listActiveBenefitProductsForPerson

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListActiveBenefitProductsForPersonDetails listActiveBenefitProductsForPerson(curam.core.facade.struct.ListActiveBenefitProductsForPersonKey key)
                                                                                                                            throws curam.util.exception.AppException,
                                                                                                                                   curam.util.exception.InformationalException

Returns a list of active benefit products for a person.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

createProductProvision

@AccessLevel(value=EXTERNAL)
void createProductProvision(curam.core.facade.struct.ProductCreateProductProvisionDetails details)
                                                  throws curam.util.exception.AppException,
                                                         curam.util.exception.InformationalException

Creates a new product provision record.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listAllProviderLocations

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListAllProviderLocations listAllProviderLocations(curam.core.facade.struct.ProductProvisionKey key)
                                                                                                 throws curam.util.exception.AppException,
                                                                                                        curam.util.exception.InformationalException

Returns a list of all provider locations.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listDeliveryPatternNames

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListDeliveryPatternNameDetails listDeliveryPatternNames(curam.core.facade.struct.ListDeliveryPatternNamesKey key)
                                                                                                       throws curam.util.exception.AppException,
                                                                                                              curam.util.exception.InformationalException

Returns a list of delivery pattern names.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listProvidersAndLocations

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListProviderAndLocationDetails listProvidersAndLocations(curam.core.facade.struct.ListProviderAndLocationKey key)
                                                                                                        throws curam.util.exception.AppException,
                                                                                                               curam.util.exception.InformationalException

Returns a list of product providers and their corresponding locations.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listProductsForCategory

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListProductDetailsStruct listProductsForCategory(curam.core.facade.struct.ListProductsForCategoryKey key)
                                                                                                throws curam.util.exception.AppException,
                                                                                                       curam.util.exception.InformationalException

Returns a list of products of a particular product category.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

createSiteMap

@AccessLevel(value=EXTERNAL)
void createSiteMap(curam.core.facade.struct.CreateSiteMapDetails details)
                                         throws curam.util.exception.AppException,
                                                curam.util.exception.InformationalException

Creates a new Site Map on a specified Product.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

modifySiteMap

@AccessLevel(value=EXTERNAL)
void modifySiteMap(curam.core.facade.struct.ModifySiteMapDetails details)
                                         throws curam.util.exception.AppException,
                                                curam.util.exception.InformationalException

Modifies Site Map details on a specified Product.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listSiteMap

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListSiteMapDetails listSiteMap(curam.core.facade.struct.ListSiteMapKey key)
                                                                              throws curam.util.exception.AppException,
                                                                                     curam.util.exception.InformationalException

Returns a list of Site Maps for a specified Product.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

readSiteMap

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadSiteMapDetails readSiteMap(curam.core.facade.struct.ReadSiteMapKey key)
                                                                              throws curam.util.exception.AppException,
                                                                                     curam.util.exception.InformationalException

Returns details of a Site Map for a specific Product.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

cancelSiteMap

@AccessLevel(value=EXTERNAL)
void cancelSiteMap(curam.core.facade.struct.CancelSiteMapDetails details)
                                         throws curam.util.exception.AppException,
                                                curam.util.exception.InformationalException

Cancels a Site Map page for a specific Product.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

createEvidenceGroupPage

@AccessLevel(value=EXTERNAL)
void createEvidenceGroupPage(curam.core.facade.struct.CreateEvidenceGroupPageDetails details)
                                                   throws curam.util.exception.AppException,
                                                          curam.util.exception.InformationalException

Creates a new Evidence Group Page for a specified Product.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

modifyEvidenceGroupPage

@AccessLevel(value=EXTERNAL)
void modifyEvidenceGroupPage(curam.core.facade.struct.ModifyEvidenceGroupPageDetails details)
                                                   throws curam.util.exception.AppException,
                                                          curam.util.exception.InformationalException

Modifies Evidence Group Page details for a specified Product.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listEvidenceGroupPage

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListEvidenceGroupPageDetails listEvidenceGroupPage(curam.core.facade.struct.ListEvidenceGroupPageKey key)
                                                                                                  throws curam.util.exception.AppException,
                                                                                                         curam.util.exception.InformationalException

Returns a list of Evidence Group Pages for a specified Product.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

readEvidenceGroupPage

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadEvidenceGroupPageDetails readEvidenceGroupPage(curam.core.facade.struct.ReadEvidenceGroupPageKey key)
                                                                                                  throws curam.util.exception.AppException,
                                                                                                         curam.util.exception.InformationalException

Returns details of an Evidence Group Page for a specific Product.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

cancelEvidenceGroupPage

@AccessLevel(value=EXTERNAL)
void cancelEvidenceGroupPage(curam.core.facade.struct.CancelEvidenceGroupPageDetails details)
                                                   throws curam.util.exception.AppException,
                                                          curam.util.exception.InformationalException

Cancels an Evidence Group Page for a specific Product.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

createEvidencePage

@AccessLevel(value=EXTERNAL)
void createEvidencePage(curam.core.facade.struct.CreateEvidencePageDetails details)
                                              throws curam.util.exception.AppException,
                                                     curam.util.exception.InformationalException

Creates a new Evidence Page for a specified Product.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

modifyEvidencePage

@AccessLevel(value=EXTERNAL)
void modifyEvidencePage(curam.core.facade.struct.ModifyEvidencePageDetails details)
                                              throws curam.util.exception.AppException,
                                                     curam.util.exception.InformationalException

Modifies Evidence Page details for a specified Product.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listEvidencePage

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListEvidencePageDetails listEvidencePage(curam.core.facade.struct.ListEvidencePageKey key)
                                                                                        throws curam.util.exception.AppException,
                                                                                               curam.util.exception.InformationalException

Returns a list of Evidence Pages for a specified Product.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

readEvidencePage

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadEvidencePageDetails readEvidencePage(curam.core.facade.struct.ReadEvidencePageKey key)
                                                                                        throws curam.util.exception.AppException,
                                                                                               curam.util.exception.InformationalException

Returns details of an Evidence Page for a specific Product.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

cancelEvidencePage

@AccessLevel(value=EXTERNAL)
void cancelEvidencePage(curam.core.facade.struct.CancelEvidencePageDetails details)
                                              throws curam.util.exception.AppException,
                                                     curam.util.exception.InformationalException

Cancels an Evidence Page for a specific Product.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listProductTimeConstaint

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListProductTimeConstraint listProductTimeConstaint(curam.core.facade.struct.ReadProductTimeConstraintRMKey key)
                                                                                                  throws curam.util.exception.AppException,
                                                                                                         curam.util.exception.InformationalException

Presentation layer method to return a list of product time constraint records.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

readProductTimeConstraint

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadProductTimeConstraint readProductTimeConstraint(curam.core.facade.struct.ProductTimeConstraintKey key)
                                                                                                   throws curam.util.exception.AppException,
                                                                                                          curam.util.exception.InformationalException

Presentation layer method to read product time constraint record.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

modifyProductTimeConstraint

@AccessLevel(value=EXTERNAL)
void modifyProductTimeConstraint(curam.core.facade.struct.ModifyProductTimeConstraint dtls)
                                                       throws curam.util.exception.AppException,
                                                              curam.util.exception.InformationalException

Presentation layer method to modify a product time constraint record.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

cancelProductTimeConstraint

@AccessLevel(value=EXTERNAL)
void cancelProductTimeConstraint(curam.core.facade.struct.CancelProductTimeConstraint key)
                                                       throws curam.util.exception.AppException,
                                                              curam.util.exception.InformationalException

Presentation layer method to cancel a product time constraint record.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

createProductTimeConstraint

@AccessLevel(value=EXTERNAL)
void createProductTimeConstraint(curam.core.facade.struct.CreateProductTimeConstraint dtls)
                                                       throws curam.util.exception.AppException,
                                                              curam.util.exception.InformationalException

Presentation layer method to create a product time constraint record.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listBenefitProductsForTypePerson

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListProductDetailsStruct listBenefitProductsForTypePerson()
                                                                                                         throws curam.util.exception.AppException,
                                                                                                                curam.util.exception.InformationalException

Returns a list of benefit products.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listLiabilityProductsForTypePerson

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListProductDetailsStruct listLiabilityProductsForTypePerson()
                                                                                                           throws curam.util.exception.AppException,
                                                                                                                  curam.util.exception.InformationalException

Returns a list of liability products.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listProductsForCategoryAndPerson

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListProductDetailsStruct listProductsForCategoryAndPerson(curam.core.facade.struct.ListProductsForCategoryKey key)
                                                                                                         throws curam.util.exception.AppException,
                                                                                                                curam.util.exception.InformationalException

Returns a filtered list of products for those products only applicable to concern roles of type Person. Typically called by a case worker during case creation.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

createEvidenceMetadata

@AccessLevel(value=EXTERNAL)
void createEvidenceMetadata(curam.core.facade.struct.EvidenceMetadataDetails details)
                                                  throws curam.util.exception.AppException,
                                                         curam.util.exception.InformationalException

Creates an Evidence Metadata record.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

modifyEvidenceMetadata

@AccessLevel(value=EXTERNAL)
void modifyEvidenceMetadata(curam.core.facade.struct.EvidenceMetadataDetails details)
                                                  throws curam.util.exception.AppException,
                                                         curam.util.exception.InformationalException

Modifies Evidence Metadata details.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

readEvidenceMetadata

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.EvidenceMetadataDetails readEvidenceMetadata(curam.core.sl.infrastructure.entity.struct.EvidenceMetadataKey key)
                                                                                            throws curam.util.exception.AppException,
                                                                                                   curam.util.exception.InformationalException

Reads Evidence Metadata details.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listEvidenceMetadata

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.EvidenceMetadataDetailsList listEvidenceMetadata()
                                                                                                throws curam.util.exception.AppException,
                                                                                                       curam.util.exception.InformationalException

Returns a list of Evidence Metadata details.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

cancelEvidenceMetadata

@AccessLevel(value=EXTERNAL)
void cancelEvidenceMetadata(curam.core.facade.struct.EvidenceMetadataRecordStatusVersionNo details)
                                                  throws curam.util.exception.AppException,
                                                         curam.util.exception.InformationalException

Cancels an Evidence Metadata entry.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

createProductEvidenceLink

@AccessLevel(value=EXTERNAL)
void createProductEvidenceLink(curam.core.facade.struct.ProductEvidenceLinkDetails details)
                                                     throws curam.util.exception.AppException,
                                                            curam.util.exception.InformationalException

Creates a Product Evidence Link record.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

deleteProductEvidenceLink

@AccessLevel(value=EXTERNAL)
void deleteProductEvidenceLink(curam.core.sl.infrastructure.struct.ProductEvidenceLinkAndEvidenceTypeKey key)
                                                     throws curam.util.exception.AppException,
                                                            curam.util.exception.InformationalException

Deletes (physically) a Product Evidence Link record.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listProductEvidenceLink

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ProductEvidenceTypeDetails listProductEvidenceLink(curam.core.struct.ProductKey key)
                                                                                                  throws curam.util.exception.AppException,
                                                                                                         curam.util.exception.InformationalException

Returns a list of Product Evidence Link details.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listCurrentActiveEvidenceMetadata

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.EvidenceMetadataDetailsList listCurrentActiveEvidenceMetadata(curam.core.struct.ProductKey productID)
                                                                                                             throws curam.util.exception.AppException,
                                                                                                                    curam.util.exception.InformationalException

Returns a list of currently active Evidence Metadata details.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listTemporalEvApprovalCheckByProductID

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.TemporalEvidenceApprovalCheckList listTemporalEvApprovalCheckByProductID(curam.core.sl.infrastructure.entity.struct.ProdIDRecStatusAndApprovTypeKey key)
                                                                                                                        throws curam.util.exception.AppException,
                                                                                                                               curam.util.exception.InformationalException

Returns a list of Temporal Evidence Approval Checks that are related to a specified product. Called in product evidence administration.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listEvidenceTypesForCreateByProductID

@AccessLevel(value=EXTERNAL)
curam.core.sl.infrastructure.struct.EvidenceTypeList listEvidenceTypesForCreateByProductID(curam.core.struct.ProductKey key)
                                                                                                                 throws curam.util.exception.AppException,
                                                                                                                        curam.util.exception.InformationalException

Returns a list of evidence types that can be used to create a Temporal Evidence Approval Check entry related to a product. Called in product evidence administration.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

createMultipleTemporalEvApprovalCheck

@AccessLevel(value=EXTERNAL)
void createMultipleTemporalEvApprovalCheck(curam.core.facade.struct.PercentageAndCommentsDetails details,
                                                                        curam.core.facade.struct.EvidenceListDetails evidenceList)
                                                                 throws curam.util.exception.AppException,
                                                                        curam.util.exception.InformationalException

Creates a Temporal Evidence Approval Check for each evidence type specified. Called during processing when an administrator is configuring Evidence Type Approval checks for products.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listProductsSharingEvidence

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ProductNameList listProductsSharingEvidence(curam.core.sl.infrastructure.entity.struct.ProductIDEvidenceTypeAndRecStatusKey key)
                                                                                           throws curam.util.exception.AppException,
                                                                                                  curam.util.exception.InformationalException

Returns a list of products which share evidence with the specified product. Called in product evidence administration.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

readTemporalEvidenceApprovalCheck

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ViewTemporalEvidenceApprovalCheck readTemporalEvidenceApprovalCheck(curam.core.facade.struct.TemporalEvidenceApprovalCheckKey key)
                                                                                                                   throws curam.util.exception.AppException,
                                                                                                                          curam.util.exception.InformationalException

Reads details of a single Temporal Evidence Approval Check entry. Called in product evidence administration.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

modifyTemporalEvidenceApprovalCheck

@AccessLevel(value=EXTERNAL)
void modifyTemporalEvidenceApprovalCheck(curam.core.facade.struct.ModifyTemporalEvidenceApprovalCheck details)
                                                               throws curam.util.exception.AppException,
                                                                      curam.util.exception.InformationalException

Modifies details of a single Temporal Evidence Approval Check. Called in product evidence administration.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

cancelTemporalEvidenceApprovalCheck

@AccessLevel(value=EXTERNAL)
void cancelTemporalEvidenceApprovalCheck(curam.core.facade.struct.TemporalEvidenceApprovalCheckKey key,
                                                                      curam.core.facade.struct.ModifyTemporalEvidenceApprovalCheck details)
                                                               throws curam.util.exception.AppException,
                                                                      curam.util.exception.InformationalException

Deletes a specified temporal evidence approval check. Called during processing when an administrator deletes an Evidence Type Approval check for a product.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listEvidenceTypesByProductID

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.EvidenceTypeList listEvidenceTypesByProductID(curam.core.sl.infrastructure.entity.struct.ProductIDAndRecordStatusKey key)
                                                                                             throws curam.util.exception.AppException,
                                                                                                    curam.util.exception.InformationalException

Lists evidence types that are related to a specified product. Called in product evidence administration.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listDeduction

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.DeductionProductLinkDetailsList listDeduction(curam.core.struct.ProductKey key)
                                                                                             throws curam.util.exception.AppException,
                                                                                                    curam.util.exception.InformationalException

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listUnassociatedDeduction

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.UnassociatedDeductionDetailsList listUnassociatedDeduction(curam.core.struct.ProductKey key)
                                                                                                          throws curam.util.exception.AppException,
                                                                                                                 curam.util.exception.InformationalException

Returns a list of deductions not associated with a product.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

readModifyDeductionDetails

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadModifyDeductionPriorityDetails readModifyDeductionDetails(curam.core.facade.struct.DeductionProductLinkKey key)
                                                                                                             throws curam.util.exception.AppException,
                                                                                                                    curam.util.exception.InformationalException

Reads deduction details to modify deduction priority.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

modifyDeductionPriority

@Deprecated
 @AccessLevel(value=EXTERNAL)
void modifyDeductionPriority(curam.core.facade.struct.ModifyDeductionPriorityDetails details)
                                                                throws curam.util.exception.AppException,
                                                                       curam.util.exception.InformationalException

Deprecated. Since Curam 6.0 SP2, replaced by modifyDeduction. Modifies the priority for a deduction product link record.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

addDeductionProductLink

@AccessLevel(value=EXTERNAL)
void addDeductionProductLink(curam.core.facade.struct.AddDeductionKey key)
                                                   throws curam.util.exception.AppException,
                                                          curam.util.exception.InformationalException

Adds deductions to a product.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

createDeductionAndProductLink

@AccessLevel(value=EXTERNAL)
void createDeductionAndProductLink(curam.core.facade.struct.CreateDeductionAndProductLinkDetails details)
                                                         throws curam.util.exception.AppException,
                                                                curam.util.exception.InformationalException

Creates a new deduction and also associates that deduction with a product.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

createDeductionProductLink

@AccessLevel(value=EXTERNAL)
void createDeductionProductLink(curam.core.facade.struct.CreateDeductionProductLinkDetails details)
                                                      throws curam.util.exception.AppException,
                                                             curam.util.exception.InformationalException

Creates an association between a deduction and a product.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

removeDeduction

@AccessLevel(value=EXTERNAL)
void removeDeduction(curam.core.facade.struct.DeductionProductLinkKey key)
                                           throws curam.util.exception.AppException,
                                                  curam.util.exception.InformationalException

Removes a deduction product link record.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

readProductTypeByProductID

@AccessLevel(value=EXTERNAL)
curam.core.struct.ProductTypeCodeIn readProductTypeByProductID(curam.core.struct.ProductKeyStruct key)
                                                                                     throws curam.util.exception.AppException,
                                                                                            curam.util.exception.InformationalException

Returns a list of products which share evidence with the specified product. Typically could be called from administration or case processing.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

createResolutionConfiguration

@AccessLevel(value=EXTERNAL)
void createResolutionConfiguration(curam.core.facade.struct.ResolutionConfigurationDtls details)
                                                         throws curam.util.exception.AppException,
                                                                curam.util.exception.InformationalException

Creates resolution configuration details.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listResolutionConfiguration

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ResolutionConfigurationDtlsList listResolutionConfiguration()
                                                                                                           throws curam.util.exception.AppException,
                                                                                                                  curam.util.exception.InformationalException

Returns a list of resolution configurations.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

removeResolutionConfiguration

@AccessLevel(value=EXTERNAL)
void removeResolutionConfiguration(curam.core.sl.entity.struct.ResolutionConfigurationKey key)
                                                         throws curam.util.exception.AppException,
                                                                curam.util.exception.InformationalException

Removes a resolution configuration record.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listResolutionsForIssue

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.IssueResLinkIDResolutionDtlsList listResolutionsForIssue(curam.core.sl.entity.struct.IssueConfigurationKey key)
                                                                                                        throws curam.util.exception.AppException,
                                                                                                               curam.util.exception.InformationalException

Returns a list resolutions already associated with a selected issue type.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listUnassignedResolutionDetails

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ResolutionConfigurationDtlsList listUnassignedResolutionDetails(curam.core.sl.entity.struct.IssueConfigurationKey key)
                                                                                                               throws curam.util.exception.AppException,
                                                                                                                      curam.util.exception.InformationalException

Returns a list of resolutions not associated with an issue.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

createResolutionForIssue

@AccessLevel(value=EXTERNAL)
void createResolutionForIssue(curam.core.facade.struct.IssueResolutionLinkDtls details)
                                                    throws curam.util.exception.AppException,
                                                           curam.util.exception.InformationalException

Creates a new resolution and also associates that resolution with an issue.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

cancelIssueResolutionLink
```
@AccessLevel(value=EXTERNAL)
void cancelIssueResolutionLink(curam.core.facade.struct.IssueResolutionLinkKey key)
                                                     throws curam.util.exception.AppException,
                                                            curam.util.exception.InformationalException
```
The link between an issue and a resolution is removed. Once removed, this resolution will no longer be available for selection when rendering a resolution on an issue. The resolution is logically deleted.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

getResolutionContextDescription

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ResolutionContextDescription getResolutionContextDescription(curam.core.sl.entity.struct.ResolutionConfigurationKey key)
                                                                                                            throws curam.util.exception.AppException,
                                                                                                                   curam.util.exception.InformationalException

Reads the resolution code table type.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

createResolutionApprovalCheckForIssue

@AccessLevel(value=EXTERNAL)
void createResolutionApprovalCheckForIssue(curam.core.facade.struct.IssueResolutionApprovalCheckDetails issueResolutionApprovalCheckDetails)
                                                                 throws curam.util.exception.AppException,
                                                                        curam.util.exception.InformationalException

This method allows an administrator to configure an approval check for a particular issue. It allows a percentage of resolutions on issues which are submitted for approval to be reviewed.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

modifyResolutionApprovalCheckForIssue

@AccessLevel(value=EXTERNAL)
void modifyResolutionApprovalCheckForIssue(curam.core.facade.struct.IssueResolutionApprovalCheckDetails issueResolutionApprovalCheckDetails)
                                                                 throws curam.util.exception.AppException,
                                                                        curam.util.exception.InformationalException

This method allows an administrator to modify an Issue Resolution Approval Check for a particular issue.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

readResolutionApprovalCheckForIssue

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadIssueResolutionApprovalCheckDetails readResolutionApprovalCheckForIssue(curam.core.facade.struct.ReadIssueResolutionApprovalCheckKey readIssueResolutionApprovalCheckKey)
                                                                                                                           throws curam.util.exception.AppException,
                                                                                                                                  curam.util.exception.InformationalException

This method allows an administrator to view a resolution approval check for a particular issue.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

cancelResolutionApprovalCheckForIssue

@AccessLevel(value=EXTERNAL)
void cancelResolutionApprovalCheckForIssue(curam.core.facade.struct.CancelIssueResolutionApprovalCheckKey cancelIssueResolutionApprovalCheckKey)
                                                                 throws curam.util.exception.AppException,
                                                                        curam.util.exception.InformationalException

This method allows an administrator to cancel an Issue Resolution Approval Check for a particular issue.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listResolutionApprovalCheckForIssue

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListIssueResolutionApprovalCheckDetails listResolutionApprovalCheckForIssue(curam.core.sl.entity.struct.IssueConfigurationKey listIssueResolutionApprovalCheckKey)
                                                                                                                           throws curam.util.exception.AppException,
                                                                                                                                  curam.util.exception.InformationalException

This method lists all existing approval checks for a particular issue.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

createIssueConfiguration

@AccessLevel(value=EXTERNAL)
void createIssueConfiguration(curam.core.facade.struct.IssueConfigurationDetails details)
                                                    throws curam.util.exception.AppException,
                                                           curam.util.exception.InformationalException

Creates a new issue configuration record.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

modifyIssueConfiguration

@AccessLevel(value=EXTERNAL)
void modifyIssueConfiguration(curam.core.facade.struct.IssueConfigurationDetails details)
                                                    throws curam.util.exception.AppException,
                                                           curam.util.exception.InformationalException

Modifies an existing issue configuration record.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

cancelIssueConfiguration

@AccessLevel(value=EXTERNAL)
void cancelIssueConfiguration(curam.core.sl.entity.struct.IssueConfigurationKey key)
                                                    throws curam.util.exception.AppException,
                                                           curam.util.exception.InformationalException

Changes the status of the issue configuration record to 'canceled'.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

readIssueConfiguration

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.IssueConfigurationDetails readIssueConfiguration(curam.core.sl.entity.struct.IssueConfigurationKey key)
                                                                                                throws curam.util.exception.AppException,
                                                                                                       curam.util.exception.InformationalException

Returns the details for an issue configuration record.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listAllIssueConfigurations

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.IssueConfigurationDetailsList listAllIssueConfigurations()
                                                                                                        throws curam.util.exception.AppException,
                                                                                                               curam.util.exception.InformationalException

Returns all active or canceled issue configuration records ordered by record status and start date.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

modifyResolutionConfiguration

@AccessLevel(value=EXTERNAL)
void modifyResolutionConfiguration(curam.core.facade.struct.ResolutionConfigurationDtls details)
                                                         throws curam.util.exception.AppException,
                                                                curam.util.exception.InformationalException

Modifies an existing resolution configuration record.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

readResolutionConfiguration

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ResolutionConfigurationDtls readResolutionConfiguration(curam.core.sl.entity.struct.ResolutionConfigurationKey key)
                                                                                                       throws curam.util.exception.AppException,
                                                                                                              curam.util.exception.InformationalException

Reads an existing Issue Resolution record.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listAllMilestoneConfigurations

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.MilestoneConfigurationDtlsList listAllMilestoneConfigurations()
                                                                                                             throws curam.util.exception.AppException,
                                                                                                                    curam.util.exception.InformationalException

Returns a list of milestone configurations.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

createMilestoneConfiguration

@AccessLevel(value=EXTERNAL)
void createMilestoneConfiguration(curam.core.facade.struct.MilestoneConfigurationDtls details)
                                                        throws curam.util.exception.AppException,
                                                               curam.util.exception.InformationalException

Creates a new milestone configuration record.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

readMilestoneConfiguration

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.MilestoneConfigurationDtls readMilestoneConfiguration(curam.core.sl.entity.struct.MilestoneConfigurationKey key)
                                                                                                     throws curam.util.exception.AppException,
                                                                                                            curam.util.exception.InformationalException

Returns the details for a milestone configuration record.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

modifyMilestoneConfiguration

@AccessLevel(value=EXTERNAL)
void modifyMilestoneConfiguration(curam.core.facade.struct.MilestoneConfigurationDtls details)
                                                        throws curam.util.exception.AppException,
                                                               curam.util.exception.InformationalException

Modifies an existing milestone configuration record.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

cancelMilestoneConfiguration

@AccessLevel(value=EXTERNAL)
void cancelMilestoneConfiguration(curam.core.sl.entity.struct.MilestoneConfigurationKey key)
                                                        throws curam.util.exception.AppException,
                                                               curam.util.exception.InformationalException

Changes the status of the milestone configuration record to 'canceled'.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

readIssueTimeConstraint

@AccessLevel(value=EXTERNAL)
curam.core.sl.entity.struct.IssueTimeConstraintDtls readIssueTimeConstraint(curam.core.sl.entity.struct.IssueTimeConstraintKey key)
                                                                                                  throws curam.util.exception.AppException,
                                                                                                         curam.util.exception.InformationalException

Reads details of an issue time constraint record.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

createIssueTimeConstraint

@AccessLevel(value=EXTERNAL)
void createIssueTimeConstraint(curam.core.sl.entity.struct.IssueTimeConstraintDtls details)
                                                     throws curam.util.exception.AppException,
                                                            curam.util.exception.InformationalException

Creates a new issue time constraint record.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

cancelIssueTimeConstraint

@AccessLevel(value=EXTERNAL)
void cancelIssueTimeConstraint(curam.core.sl.entity.struct.IssueTimeConstraintKey key)
                                                     throws curam.util.exception.AppException,
                                                            curam.util.exception.InformationalException

Cancels an existing active issue time constraint record.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

modifyIssueTimeConstraint

@AccessLevel(value=EXTERNAL)
void modifyIssueTimeConstraint(curam.core.sl.entity.struct.IssueTimeConstraintDtls details)
                                                     throws curam.util.exception.AppException,
                                                            curam.util.exception.InformationalException

Modifies an existing active issue time constraint record.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listIssueTimeConstraint

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.IssueTimeConstraintList listIssueTimeConstraint(curam.core.sl.entity.struct.IssueConfigurationKey key)
                                                                                               throws curam.util.exception.AppException,
                                                                                                      curam.util.exception.InformationalException

Returns a list of issue time constraint records for a specified issue type.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listAssessmentConfigsForProduct

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.PDAssessmentConfigurationSummaryDetailsList listAssessmentConfigsForProduct(curam.core.struct.ProductKey key)
                                                                                                                           throws curam.util.exception.AppException,
                                                                                                                                  curam.util.exception.InformationalException

This method list of all assessments associated to a product.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

createPDAssessmentConfiguration

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.PDAssessmentConfigurationKey createPDAssessmentConfiguration(curam.core.facade.struct.CreatePDAssessmentConfigurationDetails dtls)
                                                                                                            throws curam.util.exception.AppException,
                                                                                                                   curam.util.exception.InformationalException

This method creates the association between a product and assessment.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

readPDAssessmentConfiguration

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.PDAssessmentConfigurationDetails readPDAssessmentConfiguration(curam.core.facade.struct.PDAssessmentConfigurationKey key)
                                                                                                              throws curam.util.exception.AppException,
                                                                                                                     curam.util.exception.InformationalException

This method reads the details of the association between product and assessment.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

modifyPDAssessmentConfiguration

@AccessLevel(value=EXTERNAL)
void modifyPDAssessmentConfiguration(curam.core.facade.struct.ModifyPDAssessmentConfigurationDetails dtls)
                                                           throws curam.util.exception.AppException,
                                                                  curam.util.exception.InformationalException

This method modifies the association between an product and assessment configuration.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

deletePDAssessmentConfiguration

@AccessLevel(value=EXTERNAL)
void deletePDAssessmentConfiguration(curam.core.facade.struct.CancelPDAssessmentConfigurationDetails dtls)
                                                           throws curam.util.exception.AppException,
                                                                  curam.util.exception.InformationalException

This method cancels the association between an product and assessment configuration.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listPDAssessmentConfigurationByCaseID

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListAssessmentTypesForPDCaseIDListDetails listPDAssessmentConfigurationByCaseID(curam.core.facade.struct.ListAssessmentTypesForPDCaseIDKey key)
                                                                                                                               throws curam.util.exception.AppException,
                                                                                                                                      curam.util.exception.InformationalException

This method list all assessment configuration for a product delivery case.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listDistinctPDAssessmentConfigurationByCaseID

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.AssessmentConfigurationIDAndNameDetailsList listDistinctPDAssessmentConfigurationByCaseID(curam.core.facade.struct.ListAssessmentTypesForPDCaseIDKey key)
                                                                                                                                         throws curam.util.exception.AppException,
                                                                                                                                                curam.util.exception.InformationalException

This method list all the distinct assessment for the product delivery

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listActiveIssueTypes

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.IssueTypeDescriptionDetailsList listActiveIssueTypes()
                                                                                                    throws curam.util.exception.AppException,
                                                                                                           curam.util.exception.InformationalException

Returns all active issue type details.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listEvidenceTypesByCaseID

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.EvidenceTypeList listEvidenceTypesByCaseID(curam.core.struct.CaseID key)
                                                                                          throws curam.util.exception.AppException,
                                                                                                 curam.util.exception.InformationalException

Retrieves a list of all evidence types associated with the type of product for a specified case.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listAllIssueTypes

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.IssueConfigTypeList listAllIssueTypes()
                                                                                     throws curam.util.exception.AppException,
                                                                                            curam.util.exception.InformationalException

Method to list all issue types.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listAllBenefitProductTypes

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.BenefitProductTypeList listAllBenefitProductTypes()
                                                                                                 throws curam.util.exception.AppException,
                                                                                                        curam.util.exception.InformationalException

Method to list all benefit product types.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listAllLiabilityProductTypes

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.LiabilityProductTypeList listAllLiabilityProductTypes()
                                                                                                     throws curam.util.exception.AppException,
                                                                                                            curam.util.exception.InformationalException

Method to list all liability product types.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

resolveMemberHome

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ParticipantHomePageName resolveMemberHome(curam.core.facade.struct.ConcernRoleKeyStruct key)
                                                                                         throws curam.util.exception.AppException,
                                                                                                curam.util.exception.InformationalException

Resolves the home page for person and prospect person.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

readInvestigationConfiguration

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.InvestigationConfigurationDetails readInvestigationConfiguration(curam.core.sl.entity.struct.InvestigationConfigKey key)
                                                                                                                throws curam.util.exception.AppException,
                                                                                                                       curam.util.exception.InformationalException

Returns the details for an investigation configuration record.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

modifyInvestigationConfiguration

@AccessLevel(value=EXTERNAL)
void modifyInvestigationConfiguration(curam.core.facade.struct.InvestigationConfigurationDetails details)
                                                            throws curam.util.exception.AppException,
                                                                   curam.util.exception.InformationalException

Modifies an existing investigation configuration record.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listAllInvestigationConfigurations

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.InvestigationConfigurationListDetails listAllInvestigationConfigurations()
                                                                                                                        throws curam.util.exception.AppException,
                                                                                                                               curam.util.exception.InformationalException

Returns all active or canceled investigation configuration records ordered by record status and start date.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

cancelInvestigationConfiguration

@AccessLevel(value=EXTERNAL)
void cancelInvestigationConfiguration(curam.core.sl.entity.struct.InvestigationConfigKey key)
                                                            throws curam.util.exception.AppException,
                                                                   curam.util.exception.InformationalException

Changes the status of the issue configuration record to 'canceled'.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

createApprovalCheckForInvestigation

@AccessLevel(value=EXTERNAL)
void createApprovalCheckForInvestigation(curam.core.facade.struct.InvestigationApprovalCheckDetails details)
                                                               throws curam.util.exception.AppException,
                                                                      curam.util.exception.InformationalException

This method allows an administrator to configure an approval check for a particular investigation. It allows a percentage of investigations which are submitted for approval to be reviewed.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

modifyApprovalCheckForInvestigation

@AccessLevel(value=EXTERNAL)
void modifyApprovalCheckForInvestigation(curam.core.facade.struct.InvestigationApprovalCheckDetails details)
                                                               throws curam.util.exception.AppException,
                                                                      curam.util.exception.InformationalException

This method allows an administrator to modify an Investigation Approval Check for a particular investigation.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

readApprovalCheckForInvestigation

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadInvestigationApprovalCheckDetails readApprovalCheckForInvestigation(curam.core.facade.struct.ReadInvestigationApprovalCheckKey key)
                                                                                                                       throws curam.util.exception.AppException,
                                                                                                                              curam.util.exception.InformationalException

This method allows an administrator to view an approval check for a particular investigation.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

cancelApprovalCheckForInvestigation

@AccessLevel(value=EXTERNAL)
void cancelApprovalCheckForInvestigation(curam.core.facade.struct.CancelInvestigationApprovalCheckKey key)
                                                               throws curam.util.exception.AppException,
                                                                      curam.util.exception.InformationalException

This method allows an administrator to cancel an Investigation Approval Check for a particular investigation.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listApprovalCheckForInvestigation

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListInvestigationApprovalCheckDetails listApprovalCheckForInvestigation(curam.core.sl.entity.struct.InvestigationConfigKey key)
                                                                                                                       throws curam.util.exception.AppException,
                                                                                                                              curam.util.exception.InformationalException

This method lists all existing approval checks for a particular investigation.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listAssociatedMilestones

@AccessLevel(value=EXTERNAL)
curam.core.sl.struct.MilestoneConfigurationLinkDetailsList listAssociatedMilestones(curam.core.struct.ProductKey productKey)
                                                                                                          throws curam.util.exception.AppException,
                                                                                                                 curam.util.exception.InformationalException

This method is intended to be used by user to list all the milestones which are currently associated with a particular product.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

addInvestigationCaseExistingMilestone
```
@AccessLevel(value=EXTERNAL)
void addInvestigationCaseExistingMilestone(curam.core.sl.struct.AddMilestoneKey key)
                                                                 throws curam.util.exception.AppException,
                                                                        curam.util.exception.InformationalException
```
This method allows the user to select milestones to associate with a particular product from a pre-defined list, which displays all active milestones not already associated with a particular product which have an end date greater then or equal to the current date.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

createInvestigationCaseMilestone

@AccessLevel(value=EXTERNAL)
void createInvestigationCaseMilestone(curam.core.struct.ProductKey productKey,
                                                                   curam.core.facade.struct.MilestoneConfigurationDtls details)
                                                            throws curam.util.exception.AppException,
                                                                   curam.util.exception.InformationalException

Create a new milestone for a product. Once created, this milestone will be available for association with other cases.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listUnassociatedMilestone

@AccessLevel(value=EXTERNAL)
curam.core.sl.struct.MilestoneConfigurationSummaryDtlsList listUnassociatedMilestone(curam.core.struct.ProductKey productKey)
                                                                                                           throws curam.util.exception.AppException,
                                                                                                                  curam.util.exception.InformationalException

Lists all the active milestones not already associated with a particular product.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

removeMilestone

@AccessLevel(value=EXTERNAL)
void removeMilestone(curam.core.sl.entity.struct.MilestoneLinkKey key)
                                           throws curam.util.exception.AppException,
                                                  curam.util.exception.InformationalException

Removes the link between a milestone and a product.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

createInvestigationConfiguration

@AccessLevel(value=EXTERNAL)
void createInvestigationConfiguration(curam.core.facade.struct.InvestigationConfigurationDetails details)
                                                            throws curam.util.exception.AppException,
                                                                   curam.util.exception.InformationalException

Creates an investigation configuration record.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listUnassignedResolutionDetailsForInvestigation

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ResolutionConfigurationDtlsList listUnassignedResolutionDetailsForInvestigation(curam.core.sl.entity.struct.InvestigationConfigKey key)
                                                                                                                               throws curam.util.exception.AppException,
                                                                                                                                      curam.util.exception.InformationalException

Returns a list of the investigation resolutions that are not associated with an investigation.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listResolutionsForInvestigation

@AccessLevel(value=EXTERNAL)
curam.core.sl.struct.InvestigationResLinkIDResolutionDtlsList listResolutionsForInvestigation(curam.core.sl.entity.struct.InvestigationConfigKey key)
                                                                                                                    throws curam.util.exception.AppException,
                                                                                                                           curam.util.exception.InformationalException

Returns a list resolutions already associated with a selected investigation.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

createResolutionForInvestigation

@AccessLevel(value=EXTERNAL)
void createResolutionForInvestigation(curam.core.sl.entity.struct.InvestigationResolutionLinkDtls details)
                                                            throws curam.util.exception.AppException,
                                                                   curam.util.exception.InformationalException

Creates a new resolution for an investigation.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

cancelInvestigationResolutionLink

@AccessLevel(value=EXTERNAL)
void cancelInvestigationResolutionLink(curam.core.sl.entity.struct.InvestigationResolutionLinkKey key)
                                                             throws curam.util.exception.AppException,
                                                                    curam.util.exception.InformationalException

The link between an investigation and a resolution is removed. Once removed, this resolution will no longer be available for selection when rendering a resolution on an investigation. The resolution is logically deleted.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listActiveInvestigationTypes

@AccessLevel(value=EXTERNAL)
curam.core.sl.entity.struct.InvestigationIDTypeDtlsList listActiveInvestigationTypes()
                                                                                                           throws curam.util.exception.AppException,
                                                                                                                  curam.util.exception.InformationalException

Returns all current active investigation type details.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

createAndAddResolutionToInvestigation

@AccessLevel(value=EXTERNAL)
void createAndAddResolutionToInvestigation(curam.core.facade.struct.ResolutionConfigurationDtls resolutionDtls,
                                                                        curam.core.sl.entity.struct.InvestigationConfigKey investigationConfigKey)
                                                                 throws curam.util.exception.AppException,
                                                                        curam.util.exception.InformationalException

Creates and then adds a resolution configuration to an Investigation configuration.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

getSubComponentList

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.MilestoneSubComponentList getSubComponentList(curam.core.facade.struct.ComponentType key)
                                                                                             throws curam.util.exception.AppException,
                                                                                                    curam.util.exception.InformationalException

Returns a list of sub components based on the component code.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

getComponentList

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.MilestoneComponentList getComponentList(curam.core.facade.struct.ComponentBaseType key)
                                                                                       throws curam.util.exception.AppException,
                                                                                              curam.util.exception.InformationalException

Returns a list of components based on the incoming code value.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

createMilestoneForCaseType

@AccessLevel(value=EXTERNAL)
void createMilestoneForCaseType(curam.core.sl.struct.CaseTypeIDAndType key,
                                                             curam.core.facade.struct.MilestoneConfigurationDtls details)
                                                      throws curam.util.exception.AppException,
                                                             curam.util.exception.InformationalException

This method helps to create a Milestone for a Case Type with the details provided by the user.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

addExistingMilestone

@AccessLevel(value=EXTERNAL)
void addExistingMilestone(curam.core.sl.struct.AddMilestoneKey key,
                                                       curam.core.sl.struct.CaseType caseType)
                                                throws curam.util.exception.AppException,
                                                       curam.util.exception.InformationalException

This parameter will have all the information given by the user while creating a milestone for a particular case.This method helps to add the existing milestone to a selected product from list of milestones which was created earlier for different products.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listUnassociatedMilestoneForProductIDCaseType

@AccessLevel(value=EXTERNAL)
curam.core.sl.struct.MilestoneConfigurationSummaryDtlsList listUnassociatedMilestoneForProductIDCaseType(curam.core.facade.struct.ProductMilestoneLinkKey key)
                                                                                                                               throws curam.util.exception.AppException,
                                                                                                                                      curam.util.exception.InformationalException

Lists unassociated milestones for a product id and case type.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

readMilestoneConfigurationLink

@AccessLevel(value=EXTERNAL)
curam.core.sl.struct.MilestoneLinkAssociatedInfo readMilestoneConfigurationLink(curam.core.sl.entity.struct.MilestoneLinkKey key)
                                                                                                      throws curam.util.exception.AppException,
                                                                                                             curam.util.exception.InformationalException

Returns milestone link details based on the milestone link id.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

addExistingMilestoneWithConfigDetails

@AccessLevel(value=EXTERNAL)
void addExistingMilestoneWithConfigDetails(curam.core.sl.struct.AddMilestoneKey key,
                                                                        curam.core.sl.struct.CaseType caseType,
                                                                        curam.core.sl.struct.MilestoneLinkConfigDetails configDetails)
                                                                 throws curam.util.exception.AppException,
                                                                        curam.util.exception.InformationalException

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

addInvestigationCaseExistingMilestoneWithConfig

@AccessLevel(value=EXTERNAL)
void addInvestigationCaseExistingMilestoneWithConfig(curam.core.sl.struct.AddMilestoneKey key,
                                                                                  curam.core.sl.struct.MilestoneLinkConfigDetails configDetails)
                                                                           throws curam.util.exception.AppException,
                                                                                  curam.util.exception.InformationalException

This method allows the user to select milestones to associate with a particular product from a pre-defined list, which displays all active milestones not already associated with a particular product which have an end date greater then or equal to the current date.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

modifyMilestoneLinkAssociation

@AccessLevel(value=EXTERNAL)
void modifyMilestoneLinkAssociation(curam.core.sl.entity.struct.MilestoneLinkKey key,
                                                                 curam.core.sl.struct.MilestoneLinkConfigDetails details)
                                                          throws curam.util.exception.AppException,
                                                                 curam.util.exception.InformationalException

This method allows the milestone association details such as component category, component type creation event and completion event to be modified.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listAllEnabledLiabilityProducts

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListProductDetailsStruct listAllEnabledLiabilityProducts()
                                                                                                        throws curam.util.exception.AppException,
                                                                                                               curam.util.exception.InformationalException

This method returns a list of all enabled liability products.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

createBenefitProduct1

@AccessLevel(value=EXTERNAL)
void createBenefitProduct1(curam.core.facade.struct.BenefitProductDetails1 details)
                                                 throws curam.util.exception.AppException,
                                                        curam.util.exception.InformationalException

Creates a new benefit product.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

createLiabilityProduct1

@AccessLevel(value=EXTERNAL)
void createLiabilityProduct1(curam.core.facade.struct.LiabilityProductDetails1 details)
                                                   throws curam.util.exception.AppException,
                                                          curam.util.exception.InformationalException

Creates a liability product.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

modifyBenefitProduct1

@AccessLevel(value=EXTERNAL)
void modifyBenefitProduct1(curam.core.struct.ProductKeyStruct key,
                                                        curam.core.facade.struct.BenefitProductDetails1 details)
                                                 throws curam.util.exception.AppException,
                                                        curam.util.exception.InformationalException

Modifies details of a benefit product.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

modifyLiabilityProduct1

@AccessLevel(value=EXTERNAL)
void modifyLiabilityProduct1(curam.core.struct.ProductKeyStruct key,
                                                          curam.core.facade.struct.LiabilityProductDetails1 details)
                                                   throws curam.util.exception.AppException,
                                                          curam.util.exception.InformationalException

Modifies the details of a liability product.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

readBenefitProduct1

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadBenefitProductStruct1 readBenefitProduct1(curam.core.facade.struct.ReadBenefitProductKey key)
                                                                                             throws curam.util.exception.AppException,
                                                                                                    curam.util.exception.InformationalException

Reads details of a benefit product.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

readLiabilityProduct1

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadLiabilityProductStruct1 readLiabilityProduct1(curam.core.struct.ProductKeyStruct key)
                                                                                                 throws curam.util.exception.AppException,
                                                                                                        curam.util.exception.InformationalException

Reads details of a liability product.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

getProductDefaultValues

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ProductDefaultValuesDetails getProductDefaultValues()
                                                                                                   throws curam.util.exception.AppException,
                                                                                                          curam.util.exception.InformationalException

Method to return default values for product to be created.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listCorrectionProducts

@AccessLevel(value=EXTERNAL)
curam.core.struct.ProductSummaryDetailsList listCorrectionProducts()
                                                                                         throws curam.util.exception.AppException,
                                                                                                curam.util.exception.InformationalException

Returns a list of the correction products.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listBenefitProducts

@AccessLevel(value=EXTERNAL)
curam.core.struct.ProductSummaryDetailsList listBenefitProducts()
                                                                                      throws curam.util.exception.AppException,
                                                                                             curam.util.exception.InformationalException

Returns a list of the benefit products.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listLiabilityProducts

@AccessLevel(value=EXTERNAL)
curam.core.struct.ProductSummaryDetailsList listLiabilityProducts()
                                                                                        throws curam.util.exception.AppException,
                                                                                               curam.util.exception.InformationalException

Returns a list of the liability products.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

readCorrection

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.CorrectionProductDetails readCorrection(curam.core.facade.struct.ReadBenefitProductKey key)
                                                                                       throws curam.util.exception.AppException,
                                                                                              curam.util.exception.InformationalException

Reads details of a payment correction product. Called during processing when an administrative user is configuring payment correction product details.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

modifyCorrection

@AccessLevel(value=EXTERNAL)
void modifyCorrection(curam.core.facade.struct.CorrectionProductDetails details)
                                            throws curam.util.exception.AppException,
                                                   curam.util.exception.InformationalException

Modifies details of a payment correction product. Called during processing when an administrative user is configuring payment correction product details.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listApprovalCheckForInvestigationAndVersionNo

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListInvestigationApprovalCheckDetailsAndVersionNo listApprovalCheckForInvestigationAndVersionNo(curam.core.sl.entity.struct.InvestigationConfigKey key)
                                                                                                                                               throws curam.util.exception.AppException,
                                                                                                                                                      curam.util.exception.InformationalException

This method lists all existing approval checks for a particular investigation.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listResolutionApprovalCheckForIssueAndVersionNo

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListIssueResolutionApprovalCheckDetailsAndVersionNo listResolutionApprovalCheckForIssueAndVersionNo(curam.core.sl.entity.struct.IssueConfigurationKey listIssueResolutionApprovalCheckKey)
                                                                                                                                                   throws curam.util.exception.AppException,
                                                                                                                                                          curam.util.exception.InformationalException

This method lists all existing approval checks for a particular issue.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listAssessmentConfigsForProductAndVersionNo

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.PDAssessmentConfigurationSummaryDetailsListAndVersionNo listAssessmentConfigsForProductAndVersionNo(curam.core.struct.ProductKey key)
                                                                                                                                                   throws curam.util.exception.AppException,
                                                                                                                                                          curam.util.exception.InformationalException

This method list of all assessments associated to a product.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listProductTimeConstaintAndVersionNo

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListProductTimeConstraintAndVersionNo listProductTimeConstaintAndVersionNo(curam.core.facade.struct.ReadProductTimeConstraintRMKey key)
                                                                                                                          throws curam.util.exception.AppException,
                                                                                                                                 curam.util.exception.InformationalException

Presentation layer method to return a list of product time constraint records.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listRulesForProductAndVersionNo

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListRulesForProductDetailsAndVersionNo listRulesForProductAndVersionNo(curam.core.facade.struct.ListRulesForProductKey key)
                                                                                                                      throws curam.util.exception.AppException,
                                                                                                                             curam.util.exception.InformationalException

Returns a list of available RuleSets for a particular product.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

createAbsenceReasonConfiguration

@AccessLevel(value=EXTERNAL)
void createAbsenceReasonConfiguration(curam.attendance.entity.struct.AbsenceReasonConfigurationDtls dtls)
                                                            throws curam.util.exception.AppException,
                                                                   curam.util.exception.InformationalException

Creates an absence reason configuration record for the product.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

deleteAbsenceReasonConfiguration

@AccessLevel(value=EXTERNAL)
void deleteAbsenceReasonConfiguration(curam.core.facade.struct.VersionNo versionNo,
                                                                   curam.attendance.entity.struct.AbsenceReasonConfigurationKey key)
                                                            throws curam.util.exception.AppException,
                                                                   curam.util.exception.InformationalException

Deletes the absence reason configuration record.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listAbsenceReasonConfiguration

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.AbsenceReasonConfigurationDetailsList listAbsenceReasonConfiguration(curam.core.facade.struct.AssociateIDKey key)
                                                                                                                    throws curam.util.exception.AppException,
                                                                                                                           curam.util.exception.InformationalException

Returns a list of active absence reason configuration records.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

modifyAbsenceReasonConfiguration

@AccessLevel(value=EXTERNAL)
void modifyAbsenceReasonConfiguration(curam.attendance.entity.struct.AbsenceReasonConfigurationDtls dtls)
                                                            throws curam.util.exception.AppException,
                                                                   curam.util.exception.InformationalException

Modify an Absence Reason Configuration record.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

readAbsenceReasonConfiguration

@AccessLevel(value=EXTERNAL)
curam.attendance.entity.struct.AbsenceReasonConfigurationDtls readAbsenceReasonConfiguration(curam.attendance.entity.struct.AbsenceReasonConfigurationKey key)
                                                                                                                   throws curam.util.exception.AppException,
                                                                                                                          curam.util.exception.InformationalException

Reads an Absence reason configuration details.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listDeliveryPatternPreferredMethodOfPayment1

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.DeliveryPatternNamePrefMethodPmtIndDtlsList1 listDeliveryPatternPreferredMethodOfPayment1(curam.core.facade.struct.ProductIDAndConcernRoleID key)
                                                                                                                                         throws curam.util.exception.AppException,
                                                                                                                                                curam.util.exception.InformationalException

Returns a list of delivery pattern names and a curam indicator to show concern Preferred Delivery Method.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

addMilestoneCommentsTextTranslation

@AccessLevel(value=EXTERNAL)
void addMilestoneCommentsTextTranslation(curam.workspaceservices.facade.struct.LocalizableTextDetails details)
                                                               throws curam.util.exception.AppException,
                                                                      curam.util.exception.InformationalException

This method is indented to be used by user who creates translations for Milestone comments.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

addMilestoneNameTextTranslation

@AccessLevel(value=EXTERNAL)
void addMilestoneNameTextTranslation(curam.workspaceservices.facade.struct.LocalizableTextDetails details)
                                                           throws curam.util.exception.AppException,
                                                                  curam.util.exception.InformationalException

This method is indented to be used by user who creates translations for Milestone name.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

addMilestoneTypeTextTranslation

@AccessLevel(value=EXTERNAL)
void addMilestoneTypeTextTranslation(curam.workspaceservices.facade.struct.LocalizableTextDetails details)
                                                           throws curam.util.exception.AppException,
                                                                  curam.util.exception.InformationalException

This method is indented to be used by user who creates translations for Milestone type.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listLocalizableMilestoneNameText

@AccessLevel(value=EXTERNAL)
curam.workspaceservices.facade.struct.ViewLocalizableTextDetails listLocalizableMilestoneNameText(curam.workspaceservices.facade.struct.LocalizableTextDetails details)
                                                                                                                        throws curam.util.exception.AppException,
                                                                                                                               curam.util.exception.InformationalException

This method is intended to be used by users to list localizable translations of Milestone name.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listLocalizableMilestoneTypeText

@AccessLevel(value=EXTERNAL)
curam.workspaceservices.facade.struct.ViewLocalizableTextDetails listLocalizableMilestoneTypeText(curam.workspaceservices.facade.struct.LocalizableTextDetails details)
                                                                                                                        throws curam.util.exception.AppException,
                                                                                                                               curam.util.exception.InformationalException

This method is intended to be used by users to list localizable translations of Milestone type.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listLocalizableMilestoneCommentsText

@AccessLevel(value=EXTERNAL)
curam.workspaceservices.facade.struct.ViewLocalizableTextDetails listLocalizableMilestoneCommentsText(curam.workspaceservices.facade.struct.LocalizableTextDetails details)
                                                                                                                            throws curam.util.exception.AppException,
                                                                                                                                   curam.util.exception.InformationalException

This method is intended to be used by users to list localizable translations of Milestone Comments.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

modifyMilestoneNameTextTranslation

@AccessLevel(value=EXTERNAL)
void modifyMilestoneNameTextTranslation(curam.workspaceservices.facade.struct.LocalizableTextDetails details)
                                                              throws curam.util.exception.AppException,
                                                                     curam.util.exception.InformationalException

This method is indented to be used by users who modify localizable text translations of Milestone Name.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

modifyMilestoneTypeTextTranslation

@AccessLevel(value=EXTERNAL)
void modifyMilestoneTypeTextTranslation(curam.workspaceservices.facade.struct.LocalizableTextDetails details)
                                                              throws curam.util.exception.AppException,
                                                                     curam.util.exception.InformationalException

This method is indented to be used by users who modify localizable text translations of Milestone Type.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

modifyMilestoneCommentsTextTranslation

@AccessLevel(value=EXTERNAL)
void modifyMilestoneCommentsTextTranslation(curam.workspaceservices.facade.struct.LocalizableTextDetails details)
                                                                  throws curam.util.exception.AppException,
                                                                         curam.util.exception.InformationalException

This method is indented to be used by users who modify localizable text translations of Milestone Comments.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

readMilestoneNameTextTranslation

@AccessLevel(value=EXTERNAL)
curam.workspaceservices.facade.struct.TextTranslationDetails readMilestoneNameTextTranslation(curam.workspaceservices.facade.struct.LocalizableTextDetails details)
                                                                                                                    throws curam.util.exception.AppException,
                                                                                                                           curam.util.exception.InformationalException

This method is indented to be used by users to read localizable text translation of Milestone name.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

readMilestoneTypeTextTranslation

@AccessLevel(value=EXTERNAL)
curam.workspaceservices.facade.struct.TextTranslationDetails readMilestoneTypeTextTranslation(curam.workspaceservices.facade.struct.LocalizableTextDetails details)
                                                                                                                    throws curam.util.exception.AppException,
                                                                                                                           curam.util.exception.InformationalException

This method is indented to be used by users to read localizable text translation of Milestone Type.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

readMilestoneCommentsTextTranslation

@AccessLevel(value=EXTERNAL)
curam.workspaceservices.facade.struct.TextTranslationDetails readMilestoneCommentsTextTranslation(curam.workspaceservices.facade.struct.LocalizableTextDetails details)
                                                                                                                        throws curam.util.exception.AppException,
                                                                                                                               curam.util.exception.InformationalException

This method is indented to be used by users to read localizable text translation of Milestone comments.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

addDeliveryPatternNameTextTranslation

@AccessLevel(value=EXTERNAL)
void addDeliveryPatternNameTextTranslation(curam.workspaceservices.facade.struct.LocalizableTextDetails localizableTextDetails)
                                                                 throws curam.util.exception.AppException,
                                                                        curam.util.exception.InformationalException

This method is indented to be used by user who creates text translations for the DeliverPattern attribute, name.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

readDeliveryPatternNameTextTranslation

@AccessLevel(value=EXTERNAL)
curam.workspaceservices.facade.struct.TextTranslationDetails readDeliveryPatternNameTextTranslation(curam.workspaceservices.facade.struct.LocalizableTextDetails localizableTextDetails)
                                                                                                                          throws curam.util.exception.AppException,
                                                                                                                                 curam.util.exception.InformationalException

This method is indented to be used by users to read localizable text translation of DeliverPattern name.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listLocalizableDeliveryPatternNameText

@AccessLevel(value=EXTERNAL)
curam.workspaceservices.facade.struct.ViewLocalizableTextDetails listLocalizableDeliveryPatternNameText(curam.workspaceservices.facade.struct.LocalizableTextDetails localizableTextDetails)
                                                                                                                              throws curam.util.exception.AppException,
                                                                                                                                     curam.util.exception.InformationalException

This method is intended to be used by users to list localizable translations of DeliverPattern name.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

addDeliveryPatternCommentsTextTranslation

@AccessLevel(value=EXTERNAL)
void addDeliveryPatternCommentsTextTranslation(curam.workspaceservices.facade.struct.LocalizableTextDetails details)
                                                                     throws curam.util.exception.AppException,
                                                                            curam.util.exception.InformationalException

This method is indented to be used by user who creates text translations for the DeliverPattern attribute, Comments.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listLocalizableDeliveryPatternCommentsText

@AccessLevel(value=EXTERNAL)
curam.workspaceservices.facade.struct.ViewLocalizableTextDetails listLocalizableDeliveryPatternCommentsText(curam.workspaceservices.facade.struct.LocalizableTextDetails details)
                                                                                                                                  throws curam.util.exception.AppException,
                                                                                                                                         curam.util.exception.InformationalException

This method is intended to be used by users to list localizable translations of DeliverPattern Comments.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

modifyDeliveryPatternCommentsTextTranslation

@AccessLevel(value=EXTERNAL)
void modifyDeliveryPatternCommentsTextTranslation(curam.workspaceservices.facade.struct.LocalizableTextDetails details)
                                                                        throws curam.util.exception.AppException,
                                                                               curam.util.exception.InformationalException

This method is indented to be used by users who modify localizable text translations of DeliverPattern Comments.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

readDeliveryPatternCommentsTextTranslation

@AccessLevel(value=EXTERNAL)
curam.workspaceservices.facade.struct.TextTranslationDetails readDeliveryPatternCommentsTextTranslation(curam.workspaceservices.facade.struct.LocalizableTextDetails details)
                                                                                                                              throws curam.util.exception.AppException,
                                                                                                                                     curam.util.exception.InformationalException

This method is indented to be used by users to read localizable text translation of DeliverPattern Comments.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

readProductDeliveryPattern

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadProductDeliveryPatternDetails readProductDeliveryPattern(curam.core.facade.struct.ReadDeliveryPatternKey key)
                                                                                                            throws curam.util.exception.AppException,
                                                                                                                   curam.util.exception.InformationalException

This method is intended to be used by user to reads details of a delivery pattern.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

modifyProductDeliveryPattern
```
@Deprecated
 @AccessLevel(value=EXTERNAL)
void modifyProductDeliveryPattern(curam.core.facade.struct.ModifyProductDeliveryPatternDetails details)
                                                                     throws curam.util.exception.AppException,
                                                                            curam.util.exception.InformationalException
```
Deprecated. Since Curam 6.0 SP2, replaced by Product#modifyProductDeliveryPatternInfo() The existing method, modifyProductDeliveryPattern, does not support the display of informational message to be shown when the offset does not have an effect on delivery pattern. Hence the new method modifyProductDeliveryPatternInfo has been created, which will validate the offset against a delivery pattern and returns the informational message. See release note: CEF-8154

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

listAllDeliveryPatterns

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListProductDeliveryPatternDetails listAllDeliveryPatterns(curam.core.facade.struct.ListDeliveryPatternKey key)
                                                                                                         throws curam.util.exception.AppException,
                                                                                                                curam.util.exception.InformationalException

This method is intended to be used by a user to list all delivery patterns.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listMilestoneConfigurationsForCaseType

@AccessLevel(value=EXTERNAL)
curam.core.sl.struct.MilestoneConfigurationLinkDetailsList listMilestoneConfigurationsForCaseType(curam.core.sl.struct.CaseTypeIDAndType key)
                                                                                                                        throws curam.util.exception.AppException,
                                                                                                                               curam.util.exception.InformationalException

This method ins intended to be used by users to list all the Milestone configuration details of a particular Case Type ID and Case Type

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listDeductionWithVersionNo

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.DeductionProductLinkWithVersionNoDetailsList listDeductionWithVersionNo(curam.core.struct.ProductKey key)
                                                                                                                       throws curam.util.exception.AppException,
                                                                                                                              curam.util.exception.InformationalException

Returns a list of deductions for a product.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

modifyProductDeliveryPatternInfo

@AccessLevel(value=EXTERNAL)
curam.core.struct.InformationalMsgDtlsList modifyProductDeliveryPatternInfo(curam.core.facade.struct.ModifyProductDeliveryPatternDetails details)
                                                                                                  throws curam.util.exception.AppException,
                                                                                                         curam.util.exception.InformationalException

This method is intended to be used by users responsible for administrating product delivery pattern.It is used to modify the product delivery pattern.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

createDeliveryPatternInfo

@AccessLevel(value=EXTERNAL)
curam.core.struct.InformationalMsgDtlsList createDeliveryPatternInfo(curam.core.facade.struct.CreateDeliveryPatternDetails details)
                                                                                           throws curam.util.exception.AppException,
                                                                                                  curam.util.exception.InformationalException

This method is intended to be used by users responsible for administrating product delivery pattern.It is used to create the product delivery pattern.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

readDeduction

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadDeductionDtls readDeduction(curam.core.facade.struct.DeductionProductLinkKey key)
                                                                               throws curam.util.exception.AppException,
                                                                                      curam.util.exception.InformationalException

Retrieves the details for a specified Product Deduction record.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

modifyDeduction

@AccessLevel(value=EXTERNAL)
void modifyDeduction(curam.core.facade.struct.ModifyProductDeductionDetails details)
                                           throws curam.util.exception.AppException,
                                                  curam.util.exception.InformationalException

Modifies the deduction product link record.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

Interface Product