Foundations Apex API Developer Reference

fferpcore.RecordIdDeclarativeTransformRequest

global class RecordIdDeclarativeTransformRequest extends DeclarativeTransformRequest

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 differs from the RecordIdTransformRequest, which enables you to specify mappings directly. This request requires the name of a mapping process in order to automatically retrieve managed and custom mappings from the associated mapping describer.

This class extends fferpcore.DeclarativeTransformRequest

Methods

RecordIdDeclarativeTransformRequest

global RecordIdDeclarativeTransformRequest(Set<Id> recordIds, SObjectType targetObject, String process)

Create a RecordIdDeclarativeTransformRequest.

Input Parameters

Name Type Description
recordIds Set<Id> The IDs of the source SObject records to be processed.
targetObject SObjectType The type of SObject to be created or updated.
process String The name of the mapping process containing the required managed or custom mappings.

withTargetCorrelationField

global fferpcore.RecordIdDeclarativeTransformRequest 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.

withSourceCorrelationField

global fferpcore.RecordIdDeclarativeTransformRequest 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.

withCommit

global fferpcore.RecordIdDeclarativeTransformRequest 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 RecordIdDeclarativeTransformRequest instance to allow further method calls.

© Copyright 2009–2021 FinancialForce.com, inc. All rights reserved. Various trademarks held by their respective owners.