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.

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()