Btc 121 by record type (#89)

* SOQL byRecordType * byRecordType Test * byRecordType documentation
beyond-the-cloud-dev · Oct 28, 2023 · 5b7a896 · 5b7a896
1 parent 562d118
commit 5b7a896
Show file tree

Hide file tree

Showing 3 changed files with 40 additions and 0 deletions.
diff --git a/force-app/main/default/classes/SOQL.cls b/force-app/main/default/classes/SOQL.cls
@@ -112,6 +112,7 @@ public virtual inherited sharing class SOQL implements Queryable {
         // DEBUGGING
         Queryable preview();
         // PREDEFINIED
+        Queryable byRecordType(String recordTypeDeveloperName);
         Queryable byId(SObject record);
         Queryable byId(Id recordId);
         Queryable byIds(Iterable<Id> recordIds);
@@ -605,6 +606,10 @@ public virtual inherited sharing class SOQL implements Queryable {
         return executor.toQueryLocator();
     }
 
+    public SOQL byRecordType(String rtDeveloperName) {
+        return whereAre(Filter.recordType().equal(rtDeveloperName));
+    }
+
     public SOQL byId(SObject record) {
         return byId(record.Id);
     }

diff --git a/force-app/main/default/classes/SOQL_Test.cls b/force-app/main/default/classes/SOQL_Test.cls
@@ -1502,6 +1502,19 @@ private class SOQL_Test {
         Assert.areEqual('SELECT Id FROM Account ALL ROWS', soql);
     }
 
+    @IsTest
+    static void byRecordType() {
+        // Test
+        SOQL builder = SOQL.of(Case.SObjectType).byRecordType('CaseRecordType');
+
+        // Verify
+        String soql = builder.toString();
+        Assert.areEqual('SELECT Id FROM Case WHERE RecordType.DeveloperName = :v1', soql);
+
+        Map<String, Object> binding = builder.binding();
+        Assert.areEqual('CaseRecordType', binding.get('v1'));
+    }
+
     @IsTest
     static void byId() {
         // Test

diff --git a/website/docs/api/soql.md b/website/docs/api/soql.md
@@ -113,6 +113,7 @@ The following are methods for `SOQL`.
 
 [**PREDEFINIED**](#predefinied)
 
+- [`byRecordType(String recordTypeDeveloperName)`](#byrecordtype)
 - [`byId(SObject record)`](#byid)
 - [`byId(Id recordId)`](#byid)
 - [`byIds(Iterable<Id> recordIds)`](#byids)
@@ -1274,6 +1275,27 @@ WHERE ((Id = :v1 OR Name LIKE :v2))
 For all predefined methods SOQL instance is returned so you can still adjust query before execution.
 Add additional fields with [`.with`](#select).
 
+### byRecordType
+
+**Signature**
+
+```apex
+SOQL byRecordType(String recordTypeDeveloperName)
+```
+
+**Example**
+
+```sql
+SELECT Id
+FROM Case
+WHERE RecordType.DeveloperName = 'CaseRecordType'
+```
+```apex
+SOQL.of(Case.SObjectType)
+    .byRecordType('CaseRecordType')
+    .toList();
+```
+
 ### byId
 
 **Signature**