Steps

An instance of the forvendi.BreezzApi.BreezzSteps class provides tools to handle Steps operations. It helps in running groups of Steps with specific data sets and creating Step assemblers, making it easier to manage complex data tasks in the system.

runGroup(String stepGroupDevName, Object[] records)

This method runs a step group with a set of records.

Signature:

forvendi.BreezzApi.STEPS.runGroup(String stepGroupDevName, Object[] records)

Parameters:

• stepGroupDevName - name of the step group.
• records - records to pass to the step group.

Return Value:

void

build()

This method builds a default step assembler.

Signature:

forvendi.BreezzApi.STEPS.build()

Return Value:

A default step assembler.

build(String stepGroupDevName)

This method builds a step assembler for a given group.

Signature:

forvendi.BreezzApi.STEPS.build(String stepGroupDevName)

Parameters:

• stepGroupDevName - name of the step group to build.

Return Value:

A step assembler for the given group.

Steps Assembler

StepsAssembler()

Constructor for StepsAssembler class.

StepsAssembler(String stepGroupDevName)

Constructor for StepsAssembler class with a steps group name.

Parameters:

• stepGroupDevName - name of the step group.

withAllOrNone(Boolean val)

Sets allOrNone flag.

Signature:

forvendi.BreezzApi.STEPS.build().withAllOrNone(Boolean val);

Parameters:

• val - array of records to be processed.

Return Value:

The current instance of the StepsAssembler.

skipModificationContextSave()

Skips saving the modification context.

Signature:

forvendi.BreezzApi.STEPS.build().skipModificationContextSave();

Return Value:

The current instance of the StepsAssembler.

forceSyncExecution()

Forces the execution to be synchronous.

Signature:

forvendi.BreezzApi.STEPS.build().forceSyncExecution();

Return Value:

The current instance of the StepsAssembler.

addStep(Step step)

Add a step to the list of steps.

Signature:

forvendi.BreezzApi.STEPS.build().addStep(Step step);

Parameters:

• step - step to be added.

Return Value:

The current instance of the StepsAssembler.

addStep(Step step, StepConfig config)

Add a step to the list of steps.

Signature:

forvendi.BreezzApi.STEPS.build().addStep(Step step, StepConfig config);

Parameters:

• step - step to be added
• config - additional step config

Return Value:

The current instance of the StepsAssembler.

setDataStore(DataStore store)

Sets the data store.

Signature:

forvendi.BreezzApi.STEPS.build().setDataStore(DataStore store);

Parameters:

• store - data store to be set.

Return Value:

The current instance of the StepsAssembler.

getDataStore()

Gets the data store.

Signature:

forvendi.BreezzApi.STEPS.build().getDataStore();

Return Value:

The current data store.

getModificationContext()

Gets the modification context.

Signature:

forvendi.BreezzApi.STEPS.build().getModificationContext();

Return Value:

The current modification context.

setModificationContext(ModificationContext ctx)

Sets the modification context.

Signature:

forvendi.BreezzApi.STEPS.build().setModificationContext(
ModificationContex ctx);

Parameters:

• ctx - modification context to be set.

Return Value:

The current instance of the StepsAssembler.

execute(Object[] records)

Executes the given records with no optional old records.

Signature:

forvendi.BreezzApi.STEPS.build().execute(List<Object> records);

Parameters:

• records - array of records to be processed.

Return Value:

Modification context after executing the records

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

Executes the given records with optional old records.

Signature:

forvendi.BreezzApi.STEPS.build().execute(List<Object> records, List<Object> optionalOldRecords);

Parameters:

• records - array of records to be processed.
• optionalOldRecords - array of optional old records.

Return Value:

Modification context after executing the records.