Foundations Apex API Developer Reference

fferpcore.einv_MappingTargetRoot

global with sharing class einv_MappingTargetRoot implements DataTargetRoot

A base repository of einv_DocumentMappingTarget objects, used to locate and manipulate existing targets and create additional ones.

This class implements the following interfaces:

Methods

einv_MappingTargetRoot

global einv_MappingTargetRoot()

Creates an empty object repository.

withSyncScope

global fferpcore.einv_MappingTargetRoot withSyncScope(Boolean syncScope)

Flags the Work created by createWorkScope to be either synchronous or asynchronous.

Input Parameters

Name Type Description
syncScope Boolean True to return a synchronous Work from createWorkScope

Return Value

The current instance

createWorkScope

global fferpcore.DataTargetWork createWorkScope()

Creates a new Work instance. The Work can be performed either synchronously or asynchronously, The work will be done synchronously by default, unless specified using the withSyncScope method.

Return Value

The work scope responsible for committing any changes.

getAsyncResponse

global fferpcore.ElectronicInvoicingService.SendAsyncResponse getAsyncResponse()

This method used to get apex job id and should be called after transform.

Return Value

A result stating whether the apex job id, and any associated errors.

queryByKeySet

global fferpcore.TargetObjectMap queryByKeySet(Set<Object> keySet)

Locate any existing target objects with the given keys. This method must be called within a fferpcore.DataTargetWork scope.

Input Parameters

Name Type Description
keySet Set<Object> The keys to search for.

Return Value

A map of the located target objects by their respective keys.

hasAccess

global fferpcore.HasAccessResult hasAccess(List<String> keyPath)

Determine if the user has access to configure data at the given key path.

Input Parameters

Name Type Description
keyPath List<String> The key path to verify access for.

Return Value

A result stating whether the user has access, and any associated errors.

requireField

global void requireField(String key, fferpcore.Intent intent)

Require the given key from the fferpcore.DataTarget ensuring the associated data is available.

Input Parameters

Name Type Description
key String The key corresponding to the data to be made available.
intent fferpcore.Intent Why is the data at the given key required.

requireLookup

global fferpcore.DataTarget requireLookup(String key, fferpcore.Intent intent)

Require the given lookup key from the fferpcore.DataTarget ensuring the related targets are available.

Input Parameters

Name Type Description
key String The key corresponding to the related targets to be made available.
intent fferpcore.Intent Why is the data at the given key required.

Return Value

An alternate DataTarget corresponding to the related targets.

requireChildren

global fferpcore.DataTarget requireChildren(String key, fferpcore.Intent intent)

Require the given child key from the fferpcore.DataTarget ensuring the associated child targets are available.

Input Parameters

Name Type Description
key String The key corresponding to the associated child targets to be made available.
intent fferpcore.Intent Why is the data at the given key required.

Return Value

An alternate DataTarget corresponding to the associated child targets.

© Copyright 2009–2024 Certinia Inc. All rights reserved. Various trademarks held by their respective owners.