documentation + examples update

Author: pgajek2

force-app/main/default/classes/example/ExampleController.cls

@@ -1,40 +1,35 @@
 public with sharing class ExampleController {
 
-    // With Composition
-
     @AuraEnabled
     public static List<Contact> getContactsByRecordType(String recordType) {
-        return SOQL_Contact.byRecordType(recordType)
+        return SOQL_Contact.query()
+            .byRecordType(recordType)
             .with(Contact.Email, Contact.Title)
             .toList();
     }
 
     @AuraEnabled
     public static List<Contact> getContactsRelatedToAccount(Id accountId) {
-        return SOQL_Contact.byAccountId(accountId).toList();
+        return SOQL_Contact.query().byAccountId(accountId).toList();
     }
 
     @AuraEnabled
     public static String getContactName(Id contactId) {
-        return SOQL_Contact.toName(contactId);
+        return SOQL_Contact.query().toName(contactId);
     }
 
-    // With Inheritance
-
     @AuraEnabled
     public static List<Account> getPartnerAccounts(String accountName) {
-        return new SOQL_Account()
+        return SOQL_Account.query()
+            .byRecordType('Partner')
             .with(Account.BillingCity, Account.BillingCountry)
-            .whereAre(SOQL.FilterGroup
-                .add(SOQL.Filter.name().contains(accountName))
-                .add(SOQL.Filter.recordType().equal('Partner'))
-            )
+            .whereAre(SOQL.Filter.name().contains(accountName))
             .toList();
     }
 
     @AuraEnabled
     public static List<Account> getAccountsByRecordType(String recordType) {
-        return new SOQL_Account()
+        return SOQL_Account.query()
             .byRecordType(recordType)
             .byIndustry('IT')
             .with(Account.Industry, Account.AccountSource)
@@ -43,24 +38,16 @@ public with sharing class ExampleController {
 
     @AuraEnabled
     public static String getAccountIndustry(Id accountId) {
-        return new SOQL_Account().toIndustry(accountId);
-    }
-
-    // Standard (Old) Approach
-
-    @AuraEnabled
-    public static List<Opportunity> getOpportunitiesByRecordType(String recordType) {
-        return new SOQL_Opportunity().byRecordType(recordType);
+        return SOQL_Account.query().toIndustry(accountId);
     }
 
     @AuraEnabled
     public static List<Opportunity> getOpportunitiesRelatedToAccount(Id accountId) {
-        return new SOQL_Opportunity().byAccountId(accountId);
+        return SOQL_Opportunity.query().byAccountId(accountId).toList();
     }
 
-
     @AuraEnabled
     public static Integer getOpportunityAmount(Id opportunityId) {
-        return new SOQL_Opportunity().toAmount(opportunityId);
+        return SOQL_Opportunity.query().toAmount(opportunityId);
     }
 }

force-app/main/default/classes/example/inheritance/SOQL_Account.cls renamed to force-app/main/default/classes/example/SOQL_Account.cls

@@ -1,5 +1,9 @@
-public inherited sharing class SOQL_Account extends SOQL {
-    public SOQL_Account() {
+public inherited sharing class SOQL_Account extends SOQL implements SOQL.Selector {
+    public static SOQL_Account query() {
+        return new SOQL_Account();
+    }
+
+    private SOQL_Account() {
         super(Account.SObjectType);
         // default settings
         with(Account.Id, Account.Name, Account.Type)

force-app/main/default/classes/example/inheritance/SOQL_Account.cls-meta.xml renamed to force-app/main/default/classes/example/SOQL_Account.cls-meta.xml

@@ -0,0 +1,27 @@
+public inherited sharing class SOQL_Contact extends SOQL implements SOQL.Selector {
+    public static SOQL_Contact query() {
+        return new SOQL_Contact();
+    }
+
+    private SOQL_Contact() {
+        super(Contact.SObjectType);
+        // default settings
+        with(Contact.Id, Contact.Name, Contact.AccountId)
+            .systemMode()
+            .withoutSharing();
+    }
+
+    public SOQL_Contact byRecordType(String rt) {
+        whereAre(Filter.recordType().equal(rt));
+        return this;
+    }
+
+    public SOQL_Contact byAccountId(Id accountId) {
+        whereAre(Filter.with(Contact.AccountId).equal(accountId));
+        return this;
+    }
+
+    public String toName(Id contactId) {
+        return (String) query().byId(contactId).toValueOf(Contact.Name);
+    }
+}

force-app/main/default/classes/example/SOQL_Contact.cls

@@ -0,0 +1,20 @@
+public inherited sharing class SOQL_Opportunity extends SOQL implements SOQL.Selector {
+    public static SOQL_Opportunity query() {
+        return new SOQL_Opportunity();
+    }
+
+    private SOQL_Opportunity() {
+        super(Opportunity.SObjectType);
+        // default settings
+        with(Opportunity.Id, Opportunity.AccountId);
+    }
+
+    public SOQL_Opportunity byAccountId(Id accountId) {
+        whereAre(Filter.with(Opportunity.AccountId).equal(accountId));
+        return this;
+    }
+
+    public Integer toAmount(Id opportunityId) {
+        return (Integer) query().byId(opportunityId).toValueOf(Opportunity.Amount);
+    }
+}

force-app/main/default/classes/example/composition/SOQL_Contact.cls-meta.xml renamed to force-app/main/default/classes/example/SOQL_Contact.cls-meta.xml

@@ -1,6 +1,6 @@
 {
   "label": "Advanced Usage",
-  "position": 7,
+  "position": 80,
   "link": {
     "type": "generated-index"
   }