Skip to content
Breezz APEX API
BreezzApi
Describe

Describe

An instance of the forvendi.BreezzApi.BreezzDescribe class (accessible via forvendi.BreezzApi.DESCRIBE) provides utility methods for inspecting schema metadata, caching describes, retrieving record types, evaluating picklist dependencies, and generating UUIDs.

getPicklistValues(String objectApiName, String fieldApiName)

Retrieves all available picklist entry values for a specified object and field.

Signature:

public List<Schema.PicklistEntry> getPicklistValues(String objectApiName, String fieldApiName)

Parameters:

  • objectApiName: Salesforce SObject API name.
  • fieldApiName: Field API name.

Return Value: List<Schema.PicklistEntry> – List of picklist entries.

getPicklistDependencies(String objectName, String controllingField, String dependentField)

Retrieves dependent picklist values grouped by their controlling picklist entry values.

Signature:

public Map<String, List<String>> getPicklistDependencies(
    String objectName, 
    String controllingField, 
    String dependentField
)

Parameters:

  • objectName: Salesforce SObject API name.
  • controllingField: Controlling field API name.
  • dependentField: Dependent field API name.

Return Value: Map<String, List<String>> – Dependent picklist values grouped by controlling picklist values.

generateUUID()

Generates a standard Universally Unique Identifier (UUID) v4 string.

Signature:

public String generateUUID()

Return Value: String – Generated UUID value.

isValidUUID(String uuidValue)

Validates whether a given string is a correctly formatted UUID.

Signature:

public Boolean isValidUUID(String uuidValue)

Parameters:

  • uuidValue: UUID string value to validate.

Return Value: Boolean – true if valid, false otherwise.

getRecordType(Schema.SObjectType objectType, String developerName)

Returns a RecordType record matching the SObject type and developer name.

Signature:

public RecordType getRecordType(Schema.SObjectType objectType, String developerName)

Parameters:

  • objectType: Target SObjectType.
  • developerName: RecordType developer name.

Return Value: RecordType – RecordType instance.

getDefaultRecordType(Schema.SObjectType objectType)

Returns the default RecordType record for a given SObject type.

Signature:

public RecordType getDefaultRecordType(Schema.SObjectType objectType)

Parameters:

  • objectType: Target SObjectType.

Return Value: RecordType – Default RecordType instance.

getRecordTypeById(Schema.SObjectType objectType, Id recordTypeId)

Returns a RecordType record matching the specified SObject type and RecordType ID.

Signature:

public RecordType getRecordTypeById(Schema.SObjectType objectType, Id recordTypeId)

Parameters:

  • objectType: Target SObjectType.
  • recordTypeId: RecordType ID.

Return Value: RecordType – RecordType instance.

getNamespace(String objectName)

Extracts the managed package namespace prefix from an object or field API name.

Signature:

public String getNamespace(String objectName)

Parameters:

  • objectName: Object or field API name.

Return Value: String – Namespace prefix.

getAllFieldNames(SObjectType objType)

Returns a list of all field API names for an SObject type.

Signature:

public List<String> getAllFieldNames(SObjectType objType)

Parameters:

  • objType: Target SObjectType.

Return Value: List<String> – List of field API names.

getAllFieldNames(String objType)

Returns a list of all field API names for an SObject specified by name.

Signature:

public List<String> getAllFieldNames(String objType)

Parameters:

  • objType: Target SObject API name.

Return Value: List<String> – List of field API names.

getAllFields(SObjectType objType)

Returns a list of all SObjectField tokens for an SObject type.

Signature:

public List<SObjectField> getAllFields(SObjectType objType)

Parameters:

  • objType: Target SObjectType.

Return Value: List<SObjectField> – List of field tokens.

getAllFields(String objType)

Returns a list of all SObjectField tokens for an SObject specified by name.

Signature:

public List<SObjectField> getAllFields(String objType)

Parameters:

  • objType: Target SObject API name.

Return Value: List<SObjectField> – List of field tokens.

getDescribe(SObjectType objType)

Retrieves the cached DescribeSObjectResult for an SObject type.

Signature:

public Schema.DescribeSObjectResult getDescribe(SObjectType objType)

Parameters:

  • objType: Target SObjectType.

Return Value: Schema.DescribeSObjectResult – Describe result instance.

getDescribe(String objType)

Retrieves the cached DescribeSObjectResult for an SObject specified by name.

Signature:

public Schema.DescribeSObjectResult getDescribe(String objType)

Parameters:

  • objType: Target SObject API name.

Return Value: Schema.DescribeSObjectResult – Describe result instance.

getFieldDescribe(SObjectType objType, String field)

Retrieves the cached DescribeFieldResult for a field on an SObject type.

Signature:

public Schema.DescribeFieldResult getFieldDescribe(SObjectType objType, String field)

Parameters:

  • objType: Target SObjectType.
  • field: Field API name.

Return Value: Schema.DescribeFieldResult – Describe result instance.

getFieldDescribe(String objType, String field)

Retrieves the cached DescribeFieldResult for a field on an SObject specified by name.

Signature:

public Schema.DescribeFieldResult getFieldDescribe(String objType, String field)

Parameters:

  • objType: Target SObject API name.
  • field: Field API name.

Return Value: Schema.DescribeFieldResult – Describe result instance.

createInstance(String className)

Instantiates an Apex class dynamically based on its class name.

Signature:

public Object createInstance(String className)

Parameters:

  • className: Apex class or SObject type name.

Return Value: Object – Instantiated object instance.

DatesFeature