renatoliveira / apex-async-linkable

Allow to chain every kind of async apex job

Apex AsyncLinkable

This library provides all the classes required to chain all kind of async jobs in Apex.

Installation

$ sfdx force:source:deploy -p chain/src/lib

Usage

1. Create a class and extend the type of the [AsyncLinkable](https://github.com/scolladon/apex-async-linkable/blob/master/chain/src/lib/classes/AsyncLinkable.cls) class you require. Your class can have its own constructors and its own attributes of course !
2. Respect the interface contract and override the job method. start method must also be overridden for the BatchLink and ScheduleBatchLink class

The job method will contain your business logic. It can then access the private attributes of your class and the protected ones of the base class.

If you need some extra interface to make your code work, it is up to you to add them (such as Database.Stateful, Database.AllowsCallouts, etc).

You're ready to chain apex asynchronous processes!

Example for Batchable:

// Subclass BatchLink for example
public class BatchLink_EXAMPLE extends BatchLink {
  public override Database.QueryLocator start(
    Database.BatchLinkableContext bc
  ) {
    return Database.getQueryLocator('select id from account limit 1');
  }

  public BatchLink_EXAMPLE() {
    super();
  }

  protected override void job() {
    System.Debug('BatchLink_EXAMPLE');
  }
}

Example for Queueable:

//Subclass QueueLink for example
public class QueueLink_EXAMPLE extends QueueLink {
  public QueueLink_EXAMPLE() {
    super();
  }

  protected override void job() {
    System.Debug('BatchLink_EXAMPLE');
  }
}

Example chaining of a batch and queeuable instances:

// Chain both and execute them
public class Service {
  public static void doService() {
    ChainManager.instance
      .add(new BatchLink_EXAMPLE())
      .add(new QueueLink_EXAMPLE())
      .startChain();
  }
}

Improvement

Implement sub class allowing to handle BatchLink and ScheduleBatchLink with iterable in addition of QueryLocator.

Versioning

SemVer is used for versioning.

Authors

• Sebastien Colladon - Initial work - scolladon

License

This project is licensed under the MIT License - see the LICENSE.md file for details