--- schema_version: "1" id: 4e434d43aa705a75aa4080bce2885f35b111fdd0f7efaee30b72415f88bbffba title: Promotion Class collection: legacydeveloper version: current locale: en-us portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/retail_api/TPM_Promotion.md canonical_url: https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/TPM_Promotion.htm source_site: developer.salesforce.com content_type: documentation content_hash: 7afe55c02c275da5e80706bbd7b08ad7155b3f7f455c1ededeae3a596eccd1f1 description: This APEX class provides programmatic access to the TPM Promotion SObject and it’s related SObjects.Returns the List instances with the Promotion Attachment Links contents.This method creates an empty Promotion record.Returns the List instances with the Promotion Attachments contents.Returns a filtered List instances with the Promotion Product Share contents.Returns a filtered List instances with the Promotion Attachments contents.Returns a filtered List instances with the Promotion Attachment Links contents.Returns a filtered List instances with the Tactic Fund contents.Returns the List instances with the Tactic Fund contents.Returns the List instances with the Tactic contents.Returns a filtered List instances with the Tactic contents..Returns a filtered List instances with the Tactic Condition Creation Definitions contents.Returns the List instances with the Tactic Condition Creation Definitions contents.Returns the List instances with the Promotion Product Share contents.Returns the read only list of effective categories of the promotion.Returns the read only list of effective brands of the promotion.Returns a TPM_ManualInputs instance with the Manual Inputs Information.Returns a TPM_ParticipatingCustomers instance with the Participating Customers information.Returns the TPM_ProductFilter instance with the Product Filter informationIf promotionId is null, throw an exception. This method loads the Promotion record referenced by the input Promotion Id along with its related SObjects. Appends a Custom SObject Record to the TPM_Promotion instance. This record will be inserted/updated/deleted (depending on the TPM_Promotion.Record instance state) during the same transaction the Promotion object is committed to the database.Adds a Tactic Condition Creation Definition Record to the promotion. The returned wrapper can be used for further operations.Adds a Promotion Attachment Record to the promotion. The returned wrapper can be used for further operations.Adds a Promotion Attachment Link Record to the promotion. The returned wrapper can be used for further operations.Adds a Promotion Product Share Record to the promotion. The returned wrapper can be used for further operations.Adds a Tactic Fund Record to the promotion. The returned wrapper can be used for further operations.Returns the wrapper object for the record identified by the parameter id. It will search among all the records associated to the promotion.Adds a Tactic Record to the promotion. The returned wrapper can be used for further operations.Returns a TPM_Scenarios instance with the Promotion Scenarios information.Returns a TPM_SubAccounts instance with the Sub Accounts information.Notifies the TPM_Promotion instance about a relationship between 2 records. Avoid using direct DML manipulations for Records that are part of the transactional state of a Promotion. During the Promotion Save process, the records provided by the TPM_Promotion instances use temporary Id’s for records that are not still in the database. Using the methods provided by TPM_Promotion object ensures all relationships and Id’s are properly resolved before committing. Adds work to be executed after the promotion is committed to the database. Use this method to perform additional operations after all the Promotion related records are correctly committed to the database. See TPM_Promotion.DoWork reference for details about the Interface methods. Removes all the current values and reloads all the promotion data from the Database. This operation is disabled in the TPM_Promotion instance during the Save Promotion Customization Hook. Saves the all the changes contained in promotion SObject record and it’s related SObject records. This operation is disabled in the TPM_Promotion instance during the Save Promotion Customization Hook, as this method will be automatically called when the Core business logic finish processing. The method will need to check the status of the TPM_Promotion.Record wrapper (isDeleted(), isNew()) to determine the DB operation to perform. --- # Promotion Class This APEX class provides programmatic access to the TPM Promotion SObject and it’s related SObjects. ## Namespace cgcloud ## Example Implementation cgcloud.TPM\_Promotion tpmPromotion; // When saving a promotion, a new MyRecord\_\_c needs to be created MyRecord\_\_c myRecord = new MyRecord\_\_c(Param1\_\_c='Test'); // Append myRecord to the TPM\_Promotion so it's committed when // the Promotion is commited to the DB tpmPromotion.append(myRecord); - **[TPM\_Promotion Methods](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/TPM_Promotion.htm#tpm_promotion_method)** ## TPM\_Promotion Methods The following are methods for TPM\_Promotion. - **[global List getAttachmentLinks](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/TPM_Promotion.htm#method_promotion.do.work)** Returns the List instances with the Promotion Attachment Links contents. - **[global TPM\_Promotion](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/TPM_Promotion.htm#unique_814057129)** This method creates an empty Promotion record. - **[global List getAttachments](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/TPM_Promotion.htm#unique_1549953194)** Returns the List instances with the Promotion Attachments contents. - **[global List getProductShares](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/TPM_Promotion.htm#unique_1005603544)** Returns a filtered List instances with the Promotion Product Share contents. - **[global List getAttachments](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/TPM_Promotion.htm#unique_1936355116)** Returns a filtered List instances with the Promotion Attachments contents. - **[global List getAttachmentLinks](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/TPM_Promotion.htm#unique_1103905168)** Returns a filtered List instances with the Promotion Attachment Links contents. - **[global List getTacticFunds](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/TPM_Promotion.htm#unique_455028144)** Returns a filtered List instances with the Tactic Fund contents. - **[global List getTacticFunds](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/TPM_Promotion.htm#unique_786003987)** Returns the List instances with the Tactic Fund contents. - **[global List getTactics](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/TPM_Promotion.htm#unique_261214782)** Returns the List instances with the Tactic contents. - **[global List getTactics](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/TPM_Promotion.htm#unique_1177643148)** Returns a filtered List instances with the Tactic contents.. - **[global List getTacticConditionCreationDefinitions](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/TPM_Promotion.htm#unique_415272210)** Returns a filtered List instances with the Tactic Condition Creation Definitions contents. - **[global List getTacticConditionCreationDefinitions](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/TPM_Promotion.htm#unique_2060785665)** Returns the List instances with the Tactic Condition Creation Definitions contents. - **[global List getProductShares](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/TPM_Promotion.htm#unique_1499425547)** Returns the List instances with the Promotion Product Share contents. - **[global Set getEffectiveCategories](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/TPM_Promotion.htm#unique_1152435767)** Returns the read only list of effective categories of the promotion. - **[global Set getEffectiveBrands](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/TPM_Promotion.htm#unique_1681391660)** Returns the read only list of effective brands of the promotion. - **[global TPM\_ManualInputs getManualInputs](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/TPM_Promotion.htm#unique_1446774753)** Returns a TPM\_ManualInputs instance with the Manual Inputs Information. - **[global TPM\_ParticipatingCustomers getParticipatingCustomers](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/TPM_Promotion.htm#unique_1433761278)** Returns a TPM\_ParticipatingCustomers instance with the Participating Customers information. - **[global TPM\_ProductFilter getProductFilter](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/TPM_Promotion.htm#unique_1670925705)** Returns the TPM\_ProductFilter instance with the Product Filter information - **[global TPM\_Promotion](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/TPM_Promotion.htm#unique_691814707)** If promotionId is null, throw an exception. This method loads the Promotion record referenced by the input Promotion Id along with its related SObjects. - **[global TPM\_Promotion.Record append](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/TPM_Promotion.htm#unique_1467572428)** Appends a Custom SObject Record to the TPM\_Promotion instance. This record will be inserted/updated/deleted (depending on the TPM\_Promotion.Record instance state) during the same transaction the Promotion object is committed to the database. - **[global TPM\_Promotion.Record addTacticConditionCreationDefinition](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/TPM_Promotion.htm#unique_633473680)** Adds a Tactic Condition Creation Definition Record to the promotion. The returned wrapper can be used for further operations. - **[global TPM\_Promotion.Record addAttachment](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/TPM_Promotion.htm#unique_1806896538)** Adds a Promotion Attachment Record to the promotion. The returned wrapper can be used for further operations. - **[global TPM\_Promotion.Record addAttachmentLink](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/TPM_Promotion.htm#unique_325804230)** Adds a Promotion Attachment Link Record to the promotion. The returned wrapper can be used for further operations. - **[global TPM\_Promotion.Record addProductShare](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/TPM_Promotion.htm#unique_1072563787)** Adds a Promotion Product Share Record to the promotion. The returned wrapper can be used for further operations. - **[global TPM\_Promotion.Record addTacticFund](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/TPM_Promotion.htm#unique_1762786159)** Adds a Tactic Fund Record to the promotion. The returned wrapper can be used for further operations. - **[global TPM\_Promotion.Record getRecordById](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/TPM_Promotion.htm#unique_32530309)** Returns the wrapper object for the record identified by the parameter id. It will search among all the records associated to the promotion. - **[global TPM\_Promotion.TacticRecord addTactic](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/TPM_Promotion.htm#unique_1443519276)** Adds a Tactic Record to the promotion. The returned wrapper can be used for further operations. - **[global TPM\_Scenarios getScenarios](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/TPM_Promotion.htm#unique_1175276547)** Returns a TPM\_Scenarios instance with the Promotion Scenarios information. - **[global TPM\_SubAccounts getSubAccounts](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/TPM_Promotion.htm#unique_574181195)** Returns a TPM\_SubAccounts instance with the Sub Accounts information. - **[global void addRelationship](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/TPM_Promotion.htm#unique_1985794153)** Notifies the TPM\_Promotion instance about a relationship between 2 records. Avoid using direct DML manipulations for Records that are part of the transactional state of a Promotion. During the Promotion Save process, the records provided by the TPM\_Promotion instances use temporary Id’s for records that are not still in the database. Using the methods provided by TPM\_Promotion object ensures all relationships and Id’s are properly resolved before committing. - **[global void registerWork](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/TPM_Promotion.htm#unique_1679198000)** Adds work to be executed after the promotion is committed to the database. Use this method to perform additional operations after all the Promotion related records are correctly committed to the database. See TPM\_Promotion.DoWork reference for details about the Interface methods. - **[global void reload](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/TPM_Promotion.htm#unique_1532560523)** Removes all the current values and reloads all the promotion data from the Database. This operation is disabled in the TPM\_Promotion instance during the Save Promotion Customization Hook. - **[global void save](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/TPM_Promotion.htm#unique_1062091837)** Saves the all the changes contained in promotion SObject record and it’s related SObject records. This operation is disabled in the TPM\_Promotion instance during the Save Promotion Customization Hook, as this method will be automatically called when the Core business logic finish processing. The method will need to check the status of the TPM\_Promotion.Record wrapper (isDeleted(), isNew()) to determine the DB operation to perform. ### global List getAttachmentLinks Returns the List instances with the Promotion Attachment Links contents. #### API Version 55 #### Signature global List getAttachmentLinks() ### global TPM\_Promotion This method creates an empty Promotion record. #### API Version 55 #### Signature global TPM\_Promotion() ### global List getAttachments Returns the List instances with the Promotion Attachments contents. #### API Version 55 #### Signature global List getAttachments() ### global List getProductShares Returns a filtered List instances with the Promotion Product Share contents. #### API Version 55 #### Signature global List getProductShares(Boolean includeNew, Boolean includeDirty, Boolean includeDeleted ) ### global List getAttachments Returns a filtered List instances with the Promotion Attachments contents. #### API Version 55 #### Signature global List getAttachments(Boolean includeNew, Boolean includeDirty, Boolean includeDeleted ) ### global List getAttachmentLinks Returns a filtered List instances with the Promotion Attachment Links contents. #### API Version 55 #### Signature global List getAttachmentLinks(Boolean includeNew, Boolean includeDirty, Boolean includeDeleted ) ### global List getTacticFunds Returns a filtered List instances with the Tactic Fund contents. #### API Version 55 #### Signature global List getTacticFunds(Boolean includeNew, Boolean includeDirty, Boolean includeDeleted ) ### global List getTacticFunds Returns the List instances with the Tactic Fund contents. #### API Version 55 #### Signature global List getTacticFunds() ### global List getTactics Returns the List instances with the Tactic contents. #### API Version 55 #### Signature global List getTactics() ### global List getTactics Returns a filtered List instances with the Tactic contents.. #### API Version 55 #### Signature global List getTactics(Boolean includeNew, Boolean includeDirty, Boolean includeDeleted) ### global List getTacticConditionCreationDefinitions Returns a filtered List instances with the Tactic Condition Creation Definitions contents. #### API Version 55 #### Signature global List getTacticConditionCreationDefinitions(Boolean includeNew, Boolean includeDirty, Boolean includeDeleted) ### global List getTacticConditionCreationDefinitions Returns the List instances with the Tactic Condition Creation Definitions contents. #### API Version 55 #### Signature global List getTacticConditionCreationDefinitions() ### global List getProductShares Returns the List instances with the Promotion Product Share contents. #### API Version 55 #### Signature global List getProductShares() ### global Set getEffectiveCategories Returns the read only list of effective categories of the promotion. #### API Version 55 #### Signature global Set getEffectiveCategories() ### global Set getEffectiveBrands Returns the read only list of effective brands of the promotion. #### API Version 55 #### Signature global Set getEffectiveBrands() ### global TPM\_ManualInputs getManualInputs Returns a TPM\_ManualInputs instance with the Manual Inputs Information. #### API Version 55 #### Signature global TPM\_ManualInputs getManualInputs() ### global TPM\_ParticipatingCustomers getParticipatingCustomers Returns a TPM\_ParticipatingCustomers instance with the Participating Customers information. #### API Version 55 #### Signature global TPM\_ParticipatingCustomers getParticipatingCustomers() ### global TPM\_ProductFilter getProductFilter Returns the TPM\_ProductFilter instance with the Product Filter information #### API Version 55 #### Signature global TPM\_ProductFilter getProductFilter() ### global TPM\_Promotion If promotionId is null, throw an exception. This method loads the Promotion record referenced by the input Promotion Id along with its related SObjects. #### API Version 55 #### Signature global TPM\_Promotion(Id promotionId) ### global TPM\_Promotion.Record append Appends a Custom SObject Record to the TPM\_Promotion instance. This record will be inserted/updated/deleted (depending on the TPM\_Promotion.Record instance state) during the same transaction the Promotion object is committed to the database. #### API Version 55 #### Signature global TPM\_Promotion.Record append(SObject record) #### Example cgcloud.TPM\_Promotion tpmPromotion; // When saving a promotion, a new MyRecord\_\_c needs to be created MyRecord\_\_c myRecord = new MyRecord\_\_c(Param1\_\_c='Test'); // Append myRecord to the TPM\_Promotion so it's committed when // the Promotion is commited to the DB tpmPromotion.append(myRecord); ### global TPM\_Promotion.Record addTacticConditionCreationDefinition Adds a Tactic Condition Creation Definition Record to the promotion. The returned wrapper can be used for further operations. #### API Version 55 #### Signature global TPM\_Promotion.Record addTacticConditionCreationDefinition(Tactic\_Condition\_Creation\_Definition\_\_c tccd) ### global TPM\_Promotion.Record addAttachment Adds a Promotion Attachment Record to the promotion. The returned wrapper can be used for further operations. #### API Version 55 #### Signature global TPM\_Promotion.Record addAttachment(Promotion\_Attachment\_\_c pa) ### global TPM\_Promotion.Record addAttachmentLink Adds a Promotion Attachment Link Record to the promotion. The returned wrapper can be used for further operations. #### API Version 55 #### Signature global TPM\_Promotion.Record addAttachmentLink(Promotion\_Attachment\_Link\_\_c pal) ### global TPM\_Promotion.Record addProductShare Adds a Promotion Product Share Record to the promotion. The returned wrapper can be used for further operations. #### API Version 55 #### Signature global TPM\_Promotion.Record addProductShare(Promotion\_Product\_Share\_\_c pps) ### global TPM\_Promotion.Record addTacticFund Adds a Tactic Fund Record to the promotion. The returned wrapper can be used for further operations. #### API Version 55 #### Signature global TPM\_Promotion.Record addTacticFund(Tactic\_Fund\_\_c tf) ### global TPM\_Promotion.Record getRecordById Returns the wrapper object for the record identified by the parameter id. It will search among all the records associated to the promotion. #### API Version 55 #### Signature global TPM\_Promotion.Record getRecordById(Id id) ### global TPM\_Promotion.TacticRecord addTactic Adds a Tactic Record to the promotion. The returned wrapper can be used for further operations. #### API Version 55 #### Signature global TPM\_Promotion.TacticRecord addTactic(Tactic\_\_c tactic) ### global TPM\_Scenarios getScenarios Returns a TPM\_Scenarios instance with the Promotion Scenarios information. #### API Version 55 #### Signature global TPM\_Scenarios getScenarios() ### global TPM\_SubAccounts getSubAccounts Returns a TPM\_SubAccounts instance with the Sub Accounts information. #### API Version 55 #### Signature global TPM\_SubAccounts getSubAccounts() ### global void addRelationship Notifies the TPM\_Promotion instance about a relationship between 2 records. Avoid using direct DML manipulations for Records that are part of the transactional state of a Promotion. During the Promotion Save process, the records provided by the TPM\_Promotion instances use temporary Id’s for records that are not still in the database. Using the methods provided by TPM\_Promotion object ensures all relationships and Id’s are properly resolved before committing. #### API Version 55 #### Signature (TPM\_Promotion.Record child, SObjectField relationField, TPM\_Promotion.Record parent) #### Example cgcloud.TPM\_Promotion tpmPromotion; // When saving a promotion, a new MyRecord\_\_c needs to be created linked to the // Promotion\_\_c record by the MyRecord\_\_c.Promotion\_\_c field (lookup or MD field) MyRecord\_\_c myRecord = new MyRecord\_\_c(Param1\_\_c='Test'); // Append myRecord to the TPM\_Promotion so it's committed when // the Promotion is commited to the DB tpmPromotion.append(myRecord); // Register the relationship to be resolved during the save tpmPromotion.addRelationship( myRecord, // The child record, our new record MyRecord\_\_c.Promotion\_\_c, // The field that links both records, its a field on the child object tpmPromotion.getPromotion() // The parent record, in this case, the Promotion record ); ### global void registerWork Adds work to be executed after the promotion is committed to the database. Use this method to perform additional operations after all the Promotion related records are correctly committed to the database. See TPM\_Promotion.DoWork reference for details about the Interface methods. #### API Version 55 #### Signature global void registerWork(TPM\_Promotion.DoWork work) ### global void reload Removes all the current values and reloads all the promotion data from the Database. This operation is disabled in the TPM\_Promotion instance during the Save Promotion Customization Hook. #### API Version 55 #### Signature global void reload() ### global void save Saves the all the changes contained in promotion SObject record and it’s related SObject records. This operation is disabled in the TPM\_Promotion instance during the Save Promotion Customization Hook, as this method will be automatically called when the Core business logic finish processing. The method will need to check the status of the TPM\_Promotion.Record wrapper (isDeleted(), isNew()) to determine the DB operation to perform. #### API Version 55 #### Signature global void save()