Foundations Apex API Developer Reference

fferpcore.ChildSubscriptionMapping

global with sharing class ChildSubscriptionMapping implements SubscriptionMapping, CustomizableWithMappings, CustomizableWithMappings2, VirtualDataObjectTargetMapping, ClientChildMapping

Implementation of fferpcore.SubscriptionMapping that creates and updates child targets based on a list node in the message.

This class implements the following interfaces:

Methods

ChildSubscriptionMapping

global ChildSubscriptionMapping(String childKey, List<String> messageKey, fferpcore.ChildCorrelationStrategy childCorrelationStrategy)

Constructs a ChildSubscriptionMapping.

Input Parameters

Name Type Description
childKey String The key of the children in the TargetObject.
messageKey List<String> The location of the list node in the message.
childCorrelationStrategy fferpcore.ChildCorrelationStrategy The strategy used to determine how existing child targets should be dealt with.

ChildSubscriptionMapping

global ChildSubscriptionMapping(String childKey, List<String> messageKey)

Constructs a ChildSubscriptionMapping.

Input Parameters

Name Type Description
childKey String The key of the children in the TargetObject.
messageKey List<String> The location of the list node in the message.

addMappings

global fferpcore.AddMappingsResult addMappings(List<fferpcore.SubscriptionMapping> mappings)

Add child mappings with the default target child type.

Input Parameters

Name Type Description
mappings List<fferpcore.SubscriptionMapping> The child mappings to be added.

Return Value

An instance of AddMappingsResult containing the status and any errors.

addMappings

global fferpcore.AddMappingsResult addMappings(String targetChildType, List<fferpcore.SubscriptionMapping> mappings)

Add multiple child mappings for a given target child type.

Input Parameters

Name Type Description
targetChildType String The name of a type of target child object, which enables you to create multiple target child objects from a single source child object. For example, Default, Debit Line, or Admin Fee.
mappings List<fferpcore.SubscriptionMapping> The child mappings to be added.

Return Value

An instance of AddMappingsResult containing the status and any errors.

getMappings

global List<fferpcore.SubscriptionMapping> getMappings()

Return Value

The child mappings with the default target child type.

getMappings

global List<fferpcore.SubscriptionMapping> getMappings(String targetChildType)

Input Parameters

Name Type Description
targetChildType String The name of a type of target child object, which enables you to create multiple target child objects from a single source child object. For example, Default, Debit Line, or Admin Fee.

Return Value

The child mappings with the specified target child type.

withMapping

global fferpcore.ChildSubscriptionMapping withMapping(String targetChildType, fferpcore.SubscriptionMapping mapping)

Add a single child mapping for a given target child type.

Input Parameters

Name Type Description
targetChildType String The name of a type of target child object, which enables you to create multiple target child objects from a single source child object. For example, Default, Debit Line, or Admin Fee.
mapping fferpcore.SubscriptionMapping The new mapping.

Return Value

The child subscription mapping.

withMappings

global fferpcore.ChildSubscriptionMapping withMappings(String targetChildType, List<fferpcore.SubscriptionMapping> mappings)

Add multiple child mappings for a given target child type.

Input Parameters

Name Type Description
targetChildType String The name of a type of target child object, which enables you to create multiple target child objects from a single source child object. For example, Default, Debit Line, or Admin Fee.
mappings List<fferpcore.SubscriptionMapping> The new mappings.

Return Value

The child subscription mapping.

prepare

global void prepare(fferpcore.DataTarget dataTarget)

performImmediateActions

global void performImmediateActions(fferpcore.ApplyMappingRequest2 request)

withFilter

global fferpcore.ChildSubscriptionMapping withFilter(fferpcore.ChildMappingMatcher filter)

Provides a fferpcore.ChildMappingMatcher that is used to filter the child records within a child mapping.

Input Parameters

Name Type Description
filter fferpcore.ChildMappingMatcher An instance of ChildMappingMatcher defining the filter.

Return Value

The child subscription mapping.

withFilter

global fferpcore.ChildSubscriptionMapping withFilter(fferpcore.TransformFilter filter)

Provides a fferpcore.TransformFilter that is used to filter the child records within a child mapping.

Input Parameters

Name Type Description
filter fferpcore.TransformFilter An instance of TransformFilter defining the filter.

Return Value

The child subscription mapping.

performBulkActions

global void performBulkActions()

getTargetFields

global Set<String> getTargetFields()

getMessageKeys

global List<List<String>> getMessageKeys()

getTransformTableId

global String getTransformTableId()

isDeclarative

global Boolean isDeclarative()

setDeclarative

global void setDeclarative(Boolean value)

disableOutputTo

global void disableOutputTo(Set<String> output)

isDisabled

global Boolean isDisabled()

getChildren

global List<fferpcore.SubscriptionMapping> getChildren()

canHaveChildren

global Boolean canHaveChildren()

© Copyright 2009–2022 FinancialForce.com, inc. Confidential – all rights reserved. Various trademarks held by their respective owners.