SampleHandler

SampleHandler

ISTEST

This class is a sample trigger handler for use while testing the metadataTriggerHandler. Because custom metadata cannot be inserted, and because the MetadataTriggerHandler instantiates handler classes from custom metadata records, even when we stub/mock the metadata record retrieval we still need an actuall class that it can instantiate. Note, this class is annotated with @isTest to prevent it's use outside of tests, not because it contains tests.

Inheritance

TriggerHandler > SampleHandler

Fields

protected context → TriggerContext

Inherited TESTVISIBLE

---

Methods

public override void beforeInsert()

public override void beforeUpdate()

public override void afterInsert()

public override void afterupdate()

public override void beforeDelete()

public override void afterDelete()

public override void afterUndelete()

public void run()

Inherited

This is main brokering method that is called by the trigger. It's responsible for determining the proper context, and calling the correct method

Example

AccountTriggerHandler.run();

public void setMaxLoopCount(Integer max)

Inherited

Allows developers to prevent trigger loops, or allow a limited number of them by setting the maximum number of times this trigger is called.

Parameters

Param	Description
max	A valid number (generally 1) of times you'd like to allow the trigger to run.

Example

In the context of a TriggerHandler class,
this.setMaxLoopCount(5);

public void clearMaxLoopCount()

Inherited

Allows developers to turn off the max loop count

Example

In the context of a TriggerHandler class,
this.clearMaxLoopCount();

public static void bypass(String handlerName)

Inherited

Allows developers to conditionally bypass (disable) other triggers that also implement this triggerHandler

Parameters

Param	Description
handlerName	Class name (String) of the trigger handler to bypass

Example

TriggerHandler.bypass('AccountTriggerHandler');

public static void clearBypass(String handlerName)

Inherited

Removes a given trigger handler class name from the list of bypassed trigger handlers.

Parameters

Param	Description
handlerName	Handler class name to remove from the bypass list

Example

TriggerHandler.clearBypass('AccountTriggerHandler');

public static Boolean isBypassed(String handlerName)

Inherited

Allows developers to check whether a given trigger handler class is currently bypassed.

Parameters

Param	Description
handlerName	The name of the trigger handler class to check for

Returns

Type	Description
Boolean	Boolean

Example

TriggerHandler.isBypassed('AccountTriggerHandler');

public static void clearAllBypasses()

Inherited

removes all classes from the bypass list

Example

Triggerhandler.clearAllBypasses();

protected void addToLoopCount()

Inherited

TESTVISIBLE

increment the loop count

Throws

Exception	Description
Throws	loop count exception if the max loop count is reached

protected Boolean validateRun()

Inherited

TESTVISIBLE

make sure this trigger should continue to run

Returns

Type	Description
Boolean	Boolean

Throws

Exception	Description
TriggerHandlerException	thrown when executing outside of a trigger

protected void afterUpdate()

Inherited

TESTVISIBLE

SUPPRESSWARNINGS

Virtual method for the implementing class to override

---