SCM API Developer Reference

scmc.SCMPlugin

global inherited sharing virtual class SCMPlugin

class used for various scm plugins (see scm plugins custom setting for a list). extend this class and override the 'execute' method to run custom code during a specific transaction in SCM.

Author

Financial Force, Inc.

Properties

Name Type Description
doRollback boolean if true, the code initiating the plugin call will do a rollback if an exception is thrown. * If false, the custom plugin code will need to handle any database rollbacks.
throwException boolean if true, exceptions from inside the plugin will be caught, logged, and thrown again. * If false, they will just be caught and logged.

Methods

execute

global virtual void execute(Id[] recordIds)

This method will be called during the SCM transaction for the designated plugin. It must be overridden for any action to take place.

Input Parameters

Name Type Description
recordIds Id[] A list of record Ids. The type of records depends on the specific plugin.

Return Value

Does not return a value.

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