Packaged interface
Namespace: overcast
Extends ComponentPluginV2
The ComponentPluginV3 interface provides a way for Overcast Components to execute custom code.
See the Overcast Component Plugin Template for the full implementation example.
The class and method visibility must be global so the Overcast managed package can call it.
(ComponentPlugin) beforeScenarioCall(recordId, referenceFieldValues, importParameters, settings)
(ComponentPlugin) afterScenarioCall(returnedData, cmp, settings)
(ComponentPluginV2) afterComponentMetadataLoaded(recordId, cmp)
(ComponentPluginV2) afterReferenceValuesLoaded(recordId, componentName, referenceValues)
(ComponentPluginV2) onScenarioException(ex, retData)
afterReferenceValuesLoaded(recordId, componentName, referenceValues, referenceChildValues)
afterReferenceValuesLoaded(recordId, componentName, referenceValues, referenceChildValues)
Executed after the reference values are loaded from the database and before the UI is displayed to the user. Allows modification at runtime of the data loaded from referenced records before the UI is displayed.
Reference values are data from fields that are configured in the Component Builder under the Reference Values and Parameter Mappings tabs.
This method is called in addition to afterReferenceValuesLoaded(recordId, componentName, referenceValues) so only one should have an implementation.
The method visibility must be global.
Signature
void afterReferenceValuesLoaded(Id recordId, String componentName, Map<String, Map<String, Object>> referenceValues, Map<String, List<Map<String, Object>>> referenceChildValues)
Parameters
recordId
Type: Id
The ID of the record for the page the component is executing on. For example, if the component is on an Account detail screen, recordId will be the ID of the Account the user has on screen.
componentName
Type: String
The name of the currently executing component.
referenceValues
Type: Map<String, Map<String, Object>>
A collection of all the reference values that have been loaded from the database from the configured parameter mappings. The structure corresponds to that specified in the component definition, which is the same structure as returnedData in afterScenarioCall().
referenceChildValues
Type: Map<String, List<Map<String, Object>>>
A collection of all the child reference values that have been loaded from the database from the configured parameter mappings. A child reference value is defined in the Component Builder in Parameter Mappings, within the Create parameter mapping screen, when the Reference Type is set as Reference Child Object.