fferpcore.RecordIdTransformRequest

global inherited sharing class RecordIdTransformRequest extends TransformService.TransformRequest

An implementation of a fferpcore.TransformService.TransformRequest to support the common use case of generating SObject records from a collection of alternate SObject record IDs.

This class extends fferpcore.TransformService.TransformRequest

Methods

global RecordIdTransformRequest(Set<Id> sourceRecordIds, SObjectType targetObject, List<fferpcore.TransformMapping> mappings)
global fferpcore.RecordIdTransformRequest withSourceCorrelationField(SObjectField sourceCorrelationField)
global fferpcore.RecordIdTransformRequest withTargetCorrelationField(SObjectField targetCorrelationField)
global fferpcore.RecordIdTransformRequest withCommit(Boolean commitRecords)
global override fferpcore.DataTargetRoot getDataTarget()

RecordIdTransformRequest

global RecordIdTransformRequest(Set<Id> sourceRecordIds, SObjectType targetObject, List<fferpcore.TransformMapping> mappings)

Create a RecordIdTransformRequest.

Input Parameters

Name	Type	Description
sourceRecordIds	Set<Id>	The IDs of the source SObject records to be processed.
targetObject	SObjectType	The type of SObject to be created or updated.
mappings	List<fferpcore.TransformMapping>	The mappings that define how to populate the target SObjects from the source SObjects.

withSourceCorrelationField

global fferpcore.RecordIdTransformRequest withSourceCorrelationField(SObjectField sourceCorrelationField)

Specify the field that uniquely identifies the source SObject records in order to identify existing target SObject records.

Input Parameters

Name	Type	Description
sourceCorrelationField	SObjectField	The SObject field that uniquely identifies a source SObject record.

Return Value

The RecordIdTransformRequest instance to allow further method calls.

withTargetCorrelationField

global fferpcore.RecordIdTransformRequest withTargetCorrelationField(SObjectField targetCorrelationField)

Specify the field on the target SObject record in which to store the source correlation value. Required in order to identify existing target SObject records.

Input Parameters

Name	Type	Description
targetCorrelationField	SObjectField	The SObject field on the target SObject record in which to store the source record correlation value.

Return Value

The RecordIdTransformRequest instance to allow further method calls.

withCommit

global fferpcore.RecordIdTransformRequest withCommit(Boolean commitRecords)

Specify whether the target records should be committed to the database.

Input Parameters

Name	Type	Description
commitRecords	Boolean	True if the target records should be committed. False otherwise.

Return Value

The RecordIdTransformRequest instance to allow further method calls.

getDataTarget

global override fferpcore.DataTargetRoot getDataTarget()

The data target defines how target records will be created. It can be used to retrieve the transformed SObject records or check if the user has access to the target SObjects and SObjectFields.

Return Value

An instance of SObjectDataTarget.