-
Notifications
You must be signed in to change notification settings - Fork 460
CustomMetadataUtilties
This class utilizes Custom Metadata objects and the example use case we've established for Apex Recipes.
Group Custom Metadata Recipes
See CustomMetadataRecipes_Tests
SUPPRESSWARNINGS
Understanding this class, and it's utility requires understanding the use case we've setup for:
Our org has the need to periodically act on the value of picklist fields. However, sometimes we need to 'bucket' the values. This is similar to the way Case and Opportunity have 'status' picklists that are 'open' or 'closed'. Open and Closed are 'buckets' that picklist values fall into.
For our use case, and to demonstrate CustomMetadata relationships we've Setup three Custom Metadata objects:
- Bucketed_Picklist__mdt. This metadata has two metadata relationships looking up to an object entity (object__c) and a field entity (field__c) The field lookup is controlled by the object lookup. The purpose of this metadata is to concretely identify object.field references to picklists we want to bucket. Ie: Contact.AttendanceStatus__c is a bucketed picklist because a CMD record exists specifying 'Contact' as the object and 'Attendance__c' as the field.
- Picklist_Bucket__mdt. This metadata has an metadata relationship to Bucketed_Picklist__mdt. It's label serves not only as the label for the record, but also for the 'bucket' name. Ie, if we were using this setup for Opportunity's open/closed bucketing, the labels would be 'Open', and 'Closed'.
- Bucketed_Picklist_value__mdt. This metadata has a relationship to Picklist_Bucket__mdt, and represents a value that is understood to be in the bucket it's related too. For instance, given the Opportunity parallel, one value here would be 'closed/Won'. There is generally a 1:1 relationship between the picklist values of the field identified by Bucketed_Picklist__mdt, and the values of the Bucketed_Picklist_value__mdt records.
Put another way: Bucketed_Picklist__mdt belongs to one object, and one field on that obj Bucketed_Picklist_Value__mdt belongs to a single Picklist_Bucket__mdt rec Picklist_Bucket__mdt has many Bucketed_Picklist_Value__mdt records and belongs to one Bucketed_Picklist__mdt record.
This class help you solve for: What Bucket of values does the sObject record belong to in a user-scalable way that doesn't require code updates to update buckets, values or even add new bucketed picklists.
public List<Bucketed_Picklist__mdt> getBucketedPicklistsForObject(Id objId)| Name | Type | Description |
|---|---|---|
| objId | Id |
List<Bucketed_Picklist__mdt>
Convenience method accepts a list and send the first entry in the list to it's twin above.
public List<Bucketed_Picklist__mdt> getBucketedPicklistsForObject(List<Id> objIds)| Name | Type | Description |
|---|---|---|
| objIds | List<Id> |
List<Bucketed_Picklist__mdt>
SUPPRESSWARNINGS
Returns a list of bucket names that match the given search term, and list of possible fields.
public List<Picklist_Bucket__mdt> getPicklistBucketWithValues(List<Bucketed_Picklist__mdt> bPL, String search)| Name | Type | Description |
|---|---|---|
| bPL | List<Bucketed_Picklist__mdt> | Bucketed Picklist list |
| search | String | Search String for Bucketed_Picklist_Value__mdt.label |
List<Picklist_Bucket__mdt>