Skip to content
Breezz APEX API
BreezzApi
Steps

Steps

An instance of the forvendi.BreezzApi.BreezzSteps class (accessible via forvendi.BreezzApi.STEPS) provides tools to manage Step operations. It facilitates running Step Groups with specific datasets and building custom StepsAssembler pipelines.

runGroup(String stepGroupDevName, Object[] records)

Executes a configured Step Group against a collection of records.

Signature:

public void runGroup(String stepGroupDevName, Object[] records)

Parameters:

  • stepGroupDevName: Developer name of the Step Group.
  • records: Array or list of records to process.

Return Value: void

build()

Instantiates a default StepsAssembler builder.

Signature:

public forvendi.StepsAssembler build()

Return Value: forvendi.StepsAssembler – A new default step assembler instance.

build(String stepGroupDevName)

Instantiates a StepsAssembler pre-configured with a specific Step Group.

Signature:

public forvendi.StepsAssembler build(String stepGroupDevName)

Parameters:

  • stepGroupDevName: Developer name of the target Step Group.

Return Value: forvendi.StepsAssembler – A pre-configured step assembler instance.

Steps Assembler

The StepsAssembler class provides a fluent builder API to construct, configure, and execute custom step execution pipelines in memory.

StepsAssembler()

Default constructor for the StepsAssembler class.

Signature:

public StepsAssembler()

StepsAssembler(String stepGroupDevName)

Constructor initializing the assembler with a specific Step Group name.

Signature:

public StepsAssembler(String stepGroupDevName)

Parameters:

  • stepGroupDevName: Developer name of the Step Group.

withAllOrNone(Boolean val)

Sets the allOrNone transaction flag for error handling during processing.

Signature:

public forvendi.StepsAssembler withAllOrNone(Boolean val)

Parameters:

  • val: Set to true to roll back all changes if any error occurs; false to allow partial processing.

Return Value: forvendi.StepsAssembler – The current assembler instance.

skipModificationContextSave()

Prevents automatic commit of the ModificationContext at the end of step execution.

Signature:

public forvendi.StepsAssembler skipModificationContextSave()

Return Value: forvendi.StepsAssembler – The current assembler instance.

forceSyncExecution()

Forces all steps within the group to execute synchronously, overriding asynchronous settings.

Signature:

public forvendi.StepsAssembler forceSyncExecution()

Return Value: forvendi.StepsAssembler – The current assembler instance.

addStep(Step step)

Appends a custom Step instance to the execution pipeline.

Signature:

public forvendi.StepsAssembler addStep(forvendi.Step step)

Parameters:

  • step: The custom Step instance to add.

Return Value: forvendi.StepsAssembler – The current assembler instance.

addStep(Step step, StepConfig config)

Appends a custom Step instance along with specific execution configuration settings.

Signature:

public forvendi.StepsAssembler addStep(forvendi.Step step, forvendi.StepConfig config)

Parameters:

  • step: The custom Step instance to add.
  • config: Additional configuration options for the step.

Return Value: forvendi.StepsAssembler – The current assembler instance.

setDataStore(DataStore store)

Sets a custom DataStore instance for the assembler pipeline.

Signature:

public forvendi.StepsAssembler setDataStore(forvendi.DataStore store)

Parameters:

  • store: The DataStore instance to attach.

Return Value: forvendi.StepsAssembler – The current assembler instance.

getDataStore()

Retrieves the DataStore instance currently attached to the assembler.

Signature:

public forvendi.DataStore getDataStore()

Return Value: forvendi.DataStore – The active DataStore instance.

getModificationContext()

Retrieves the ModificationContext attached to the assembler.

Signature:

public forvendi.ModificationContext getModificationContext()

Return Value: forvendi.ModificationContext – The active ModificationContext instance.

setModificationContext(ModificationContext ctx)

Sets a specific ModificationContext for record update staging.

Signature:

public forvendi.StepsAssembler setModificationContext(forvendi.ModificationContext ctx)

Parameters:

  • ctx: The ModificationContext instance to assign.

Return Value: forvendi.StepsAssembler – The current assembler instance.

execute(Object[] records)

Executes the step pipeline for a given set of input records.

Signature:

public forvendi.ModificationContext execute(List<Object> records)

Parameters:

  • records: List or array of records to be processed.

Return Value: forvendi.ModificationContext – The resulting ModificationContext after execution.

execute(Object[] records, Object[] optionalOldRecords)

Executes the step pipeline for new records alongside their previous state (oldMap/oldList).

Signature:

public forvendi.ModificationContext execute(List<Object> records, List<Object> optionalOldRecords)

Parameters:

  • records: List or array of new records to process.
  • optionalOldRecords: List or array of prior state records.

Return Value: forvendi.ModificationContext – The resulting ModificationContext after execution.

SchedulerTests