Consumer Goods Cloud Developer Guide

Get Started with Consumer Goods Cloud
Retail Execution
Trade Promotion Management
Custom Objects for Trade Promotion Management
Exporting the KPIs from Hyperforce
Trade Promotion Management Business APIs
Apex Classes for Trade Promotion Management
Calendar Launchpad Customization
DataCloudExportScheduler Class
JobStatusNotificationService Class
Promotion and Tactic Transfer Customization
Promotion Header LWCs
PromotionPushRemoteActionExtension Class
RTR Report Classes
ScheduleTPMAccrualProcessChain Class
tpmGenericUtils Module
Account Plan LWC Reference
Manual Inputs Class
tpm-promotion Component
ParticipatingCustomers Class
TPM_ParticipatingCustomers Methods
ParticipatingCustomers.ParticipatingCustomer Class
ProductFilter Class
ProductFilter.ManualProduct Class
Promotion Class
Promotion.DoWork Class
Promotion.Record
Promotion.TacticRecord
SubAccounts
SubAccounts.SubAccount
Scenarios Class
Scenarios.ScenarioParameter Class
User Interface Customization
UI Edit Access Rights Customization
Trade Promotion Management Service APIs
Trade Promotion Management Transformation Engine Workflows
Promotion Creation Workflow
Promotion Copy Workflow
Scheduling Jobs
Derive and Copy Promotions with MetadataWizard and Business Object API
Promotion Wizards & Customization
Metadata Wizard
Business Objects API
Custom Objects for Retail Execution and Trade Promotion Management
Standard and Custom Objects for Future Use
API End-of-Life Policy
PDF

Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

ParticipatingCustomers Class

This APEX class provides programmatic access to the TPM Promotion Participating Customers List used in the Promotion Push process.

Namespace

1cgcloud

TPM_ParticipatingCustomers Methods

The following are methods for TPM_ParticipatingCustomers.

global Object toGenericObject

Serializes the information of the participating customers to a generic Object instance. Useful for using the information in Remote calls.

API Version

55

Signature

global Object toGenericObject()

global ParticipatingCustomer addParticipatingCustomer

Adds a new Participating Customer to the instance. The input parameters are the external id of the Account records and a boolean parameter to determine if the participating customer is included or excluded.

API Version

55

Signature

global ParticipatingCustomer addParticipatingCustomer(String externalid, Boolean included)

global List<ParticipatingCustomer> getParticipatingCustomers

Adds a new Participating Customer to the instance. The input parameters are the external id of the Account records and a boolean parameter to determine if the participating customer is included or excluded.

API Version

55

Signature

global List<ParticipatingCustomer> getParticipatingCustomers()

global void removeParticipatingCustomer

Removes the passed in participating customer from the instance. If the participating customers is not contained in the instance, nothing is removed.

API Version

55

Signature

global void removeParticipatingCustomer(ParticipatingCustomer sa)

global String toJSON

Serializes the information of the participating customers information for storage.

API Version

55

Signature

global String toJSON()

global TPM_ParticipatingCustomers

Creates an empty structure with no participating customers.

API Version

55

Signature

global TPM_ParticipatingCustomers()

global TPM_ParticipatingCustomers load

Deserializes the information of the participating customers from the input generic object. The current instance will be cleared and the participating customers represented by the input will be loaded.

API Version

55

Signature

global TPM_ParticipatingCustomers load(Object data)

global TPM_ParticipatingCustomers load

Deserializes the information of the participating customers from the input payload. The current instance will be cleared and the participating customers represented by the payload will be loaded.

API Version

55

Signature

global TPM_ParticipatingCustomers load(String payload)

global void clear

Removes all information about all participating customers for the current instance.

API Version

55

Signature

global void clear()