Newer Version Available

This content describes an older version of this product. View Latest

TPM_Scenarios.ScenarioParameter Class

This APEX class provides programmatic access to a single scenario parameter information contained in a TPM_Scenarios instance.

The content in this Consumer Goods Cloud Trade Promotion Management documentation is confidential and may be viewed only by customers or partners as authorized by Salesforce, and copying and further distribution is prohibited without prior written consent from Salesforce. The content is the highly confidential and proprietary information of Salesforce and is protected under the confidentiality obligations of your Agreement with Salesforce. Accordingly, the content may be used only as necessary in order to implement the Consumer Goods Cloud Trade Promotion Management functionality.

The content in this documentation is being released as a preview, and is not generally available and may contain errors. Salesforce is providing this documentation as-is, and makes no representations or warranties as to the accuracy of the content contained in this documentation. Salesforce reserves the right to update and revise this documentation, and content describing features of Consumer Goods Cloud Trade Promotion Management may be modified, added, or removed. If Salesforce distributes or releases updated versions of this documentation, you acknowledge and agree that you will delete and destroy any prior versions of this documentation.

Important

Namespace

TPM_Scenarios Methods

The following are methods for TPM_Scenarios.ScenarioParameter.

global Boolean isApplied

Returns the scenario parameter applied flag. If applied, UI will not re-apply the value when loading the scenario information. If not applied, when loading the scenario, UI will apply the value of the parameter to the total of the KPI) .

API Version

55

Signature

global Boolean isApplied()

global Decimal getValue

Returns the KPI Value of the Scenario Parameter.

API Version

55

Signature

global Decimal getValue()

global ScenarioParameter setKPIName

Sets the scenario parameter KPI Name.

API Version

55

Signature

global ScenarioParameter setKPIName(String kpi)

global ScenarioParameter setApplied

Sets the scenario parameter applied flag. If applied, UI will not re-apply the value when loading the scenario information. If not applied, when loading the scenario, UI will apply the value of the parameter to the total of the KPI) .

API Version

55

Signature

global ScenarioParameter setApplied(Boolean applied)

global ScenarioParameter setValue

Sets the scenario parameter KPI value.

API Version

55

Signature

global ScenarioParameter setValue(Decimal value)

global String getKPIName

Returns the KPI Name of the Scenario Parameter.

API Version

55

Signature

global String getKPIName()