Skip to content

SVC_Omnistudio.Parameters

Class

apex
global inherited sharing class SVC_Omnistudio.Parameters

A Data Transfer Object (DTO) used to wrap the original parameters provided by Omnistudio, organizing them into distinct input, output, and option maps. This global inherited sharing class is designed to simplify the retrieval and management of these parameters within an Omnistudio context.

Since: 1.0


Properties

PropertyDescription
global Map inputMapProvides access to all input variables provided in the parameter map.
global Map optionMapProvides access to various option parameters that control the behavior of the call operation.
global Map outputMapProvides access to the output map where results of the operation can be stored.

Methods

MethodDescription
global Object getInputVariable(String key)Retrieves the value of an input variable from the input map.
global Object getOptionVariable(String key)Retrieves the value of an option variable from the options map.
global void setOutputVariable(String key, Object value)Sets the value of an output variable in the output map.

Property Details

inputMap

apex
global Map<String, Object> inputMap

Type: Map

Provides access to all input variables provided in the parameter map.

Since:

Example:

optionMap

apex
global Map<String, Object> optionMap

Type: Map

Provides access to various option parameters that control the behavior of the call operation.

Since:

Example:

outputMap

apex
global Map<String, Object> outputMap

Type: Map

Provides access to the output map where results of the operation can be stored.

Since:

Example:


Method Details

getInputVariable

apex
global Object getInputVariable(String key)

Retrieves the value of an input variable from the input map.

Parameters:

  • key (String) - The name of the input variable to retrieve.

Returns: Object - Returns the value associated with the specified key, or null if the key is not found.

Since: 1.0

Example:

apex
Object result = instance.getInputVariable('value');

getOptionVariable

apex
global Object getOptionVariable(String key)

Retrieves the value of an option variable from the options map.

Parameters:

  • key (String) - The name of the option variable to retrieve.

Returns: Object - Returns the value associated with the specified key, or null if the key is not found.

Since: 1.0

Example:

apex
Object result = instance.getOptionVariable('value');

setOutputVariable

apex
global void setOutputVariable(String key, Object value)

Sets the value of an output variable in the output map. This method is used to store the results of operations for retrieval after method execution.

Parameters:

  • key (String) - The name of the output variable to set.
  • value (Object) - The value to assign to the specified key in the output map.

Since: 1.0

Example:

apex
instance.setOutputVariable('value', 'value');