Foundations Apex API Developer Reference

fferpcore.LookupSubscriptionMapping

global with sharing class LookupSubscriptionMapping implements SubscriptionMapping, ClientLookupMapping

A subscription mapping that populates the specified target field with data from a record on a related object, typically its ID.

This class implements the following interfaces:

Methods

LookupSubscriptionMapping

global LookupSubscriptionMapping(String targetKey, List<List<String>> messageKeys)

Construct a lookup subscription mapping.

Input Parameters

Name Type Description
targetKey String Field on the TargetObject to populate.
messageKeys List<List<String>> Location of the data in the message, used to locate the related record.

withLookupObject

global fferpcore.LookupSubscriptionMapping withLookupObject(SObjectType lookupObject)

Specify the SObjectType containing the record to be located. Useful when using a target field that is not a lookup field.

Input Parameters

Name Type Description
lookupObject SObjectType The SObjectType of the lookup object.

Return Value

The instance of the LookupSubscriptionMapping to enable fluent invocations.

withQueryFields

global fferpcore.LookupSubscriptionMapping withQueryFields(List<SObjectField> queryFields)

Specify the fields on the lookup object to use to locate the record. By default, this is only the name field.

Input Parameters

Name Type Description
queryFields List<SObjectField> A list of SObjectField to query on the lookup object.

Return Value

The instance of the LookupSubscriptionMapping to enable fluent invocations.

withResultField

global fferpcore.LookupSubscriptionMapping withResultField(SObjectField resultField)

Specify the field on the located record that populates the target field. By default, this is the record ID.

Input Parameters

Name Type Description
resultField SObjectField A field on the lookup object that populates the target field.

Return Value

The instance of the LookupSubscriptionMapping to enable fluent invocations.

prepare

global void prepare(fferpcore.DataTarget dt)

performImmediateActions

global void performImmediateActions(fferpcore.ApplyMappingRequest2 request)

performBulkActions

global void performBulkActions()

disableOutputTo

global void disableOutputTo(Set<String> output)

isDisabled

global Boolean isDisabled()

getTargetFields

global Set<String> getTargetFields()

getMessageKeys

global List<List<String>> getMessageKeys()

isDeclarative

global Boolean isDeclarative()

setDeclarative

global void setDeclarative(Boolean value)

getChildren

global List<fferpcore.SubscriptionMapping> getChildren()

canHaveChildren

global Boolean canHaveChildren()

getTransformTableId

global String getTransformTableId()

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