Breezz APEX API

Welcome to the Breezz APEX API documentation. This section provides reference material for the framework’s Apex entry points, asynchronous processing engines, database abstraction layers, execution pipelines, scheduled workers, and extensible interfaces.

The Breezz Apex API exposes programmatic interfaces to interact with the framework’s execution engine, database utilities, asynchronous queuing systems, logging, and unit testing frameworks.

Developers can leverage these Apex namespaces and utilities to trigger processes programmatically, manipulate modification contexts, handle complex data loading, and inspect system states.

API Modules Overview

Explore the primary API sub-modules using the navigation links or the sidebar menu:

a. BreezzAPI

Core entry point for framework controls, logger utilities, feature toggles, and test context setup (forvendi.BreezzApi), exposing platform sub-services such as Logger, Describe, Feature, Triggers, and Tests.

b. Async

Asynchronous processing engines, queue management (AsyncRequest), execution strategy wrappers, and background error tracking (AsyncJobInfo, AsyncJobError).

c. Database

Safe, transactional DML execution abstractions (DB), dynamic sharing security modes, query caching (DataStore), and batch modification contexts (ModificationContext).

d. Scheduler

Framework infrastructure for Queueable and Batch Apex jobs (SchedulerJobInfo, SchedulerQueueable, SchedulerBatch).

e. Step

Atomic functional execution units, pipeline lifecycle hooks, and async offloading logic.

f. Metrics

Data structures for measuring system limit usage and execution performance.

g. Interfaces

Contracts and framework interfaces required when implementing custom plugins, background workers, trigger hooks, or custom feature toggle evaluators.

Quick Entry Example

// Check features & system mode
Boolean isSandbox = forvendi.BreezzApi.FEATURE.isSandbox();

// Initialize safe DML context
forvendi.ModificationContext ctx = forvendi.BreezzApi.DATABASE.createModificationContext();
ctx.addToUpdate(accountRecord);
ctx.save();

// Log exceptions with automatic DML caching
forvendi.BreezzApi.LOGGER.addErrorLog('AccountService', 'processRecords', ex);
forvendi.BreezzApi.LOGGER.save();