Describe

An instance of the forvendi.BreezzApi.BreezzDescribe class which provides describing methods.


getPicklistValues(String objectApiName, String fieldApiName)

Gets all picklist values

Signature:

forvendi.BreezzApi.DESCRIBE.getPicklistValues(String objectApiName, String fieldApiName);

Parameters:

  • objectApiName - salesforce object api names
  • fieldApiName - object field api name

Return Value:

List of the picklist values


getPicklistDependencies(String objectName, String controllingField, String dependentField)

Gets the all dependent values available for the controlling picklist value

Signature:

forvendi.BreezzApi.DESCRIBE.getPicklistDependencies(String objectName, String controllingField, String dependentField);

Parameters:

  • objectName - salesforce object api names
  • controllingField controlling field api name
  • dependentField dependent field api name

Return Value:

Dependent picklist values grouped by controlling picklist value


generateUUID()

Generates UUID value

Signature:

forvendi.BreezzApi.DESCRIBE.generateUUID();

Return Value:

UUID value


isValidUUID(String uuidValue)

Checks if UUID is valid

Signature:

forvendi.BreezzApi.DESCRIBE.isValidUUID(String uuidValue);

Parameters:

  • uuidValue - UUID value to validate

Return Value:

True when UUID is valid


getRecordType(Schema.SObjectType objectType, String developerName)

Returns Record Type record by Object type and developer name.

Signature:

forvendi.BreezzApi.DESCRIBE.getRecordType(Schema.SObjectType objectType, String developerName);

Parameters:

  • objectType - SObject type
  • developerName - record type developer name

Return Value:

RecordType instance.


getDefaultRecordType(Schema.SObjectType objectType)

Returns Default Record Type record by Object type.

Signature:

forvendi.BreezzApi.DESCRIBE.getDefaultRecordType(Schema.SObjectType objectType);

Parameters:

  • objectType - SObject type

Return Value:

RecordType instance.


getRecordTypeById(Schema.SObjectType objectType, Id recordTypeId)

Returns Record Type record by record type Id.

Signature:

forvendi.BreezzApi.DESCRIBE.getRecordTypeById(Schema.SObjectType objectType, Id recordTypeId);

Parameters:

  • objectType - SObject type
  • recordTypeId - RecordType Id

Return Value:

RecordType instance.


getNamespace(String objectName)

Gets namespace from object or field name

Signature:

forvendi.BreezzApi.DESCRIBE.getNamespace(String objectName);

Parameters:

  • objectName - object or field name

Return Value:

Namespace


getAllFieldNames(SObjectType objType)

Returns all SObject fields

Signature:

forvendi.BreezzApi.DESCRIBE.getAllFieldNames(SObjectType objType);

Parameters:

  • objType - salesforce SObject name

Return Value:

Field names list


getAllFieldNames(String objType)

Returns all SObject fields

Signature:

forvendi.BreezzApi.DESCRIBE.getAllFieldNames(String objType);

Parameters:

  • objType - salesforce SObject name

Return Value:

Field names list


getAllFields(SObjectType objType)

Returns all SObject fields

Signature:

forvendi.BreezzApi.DESCRIBE.getAllFields(SObjectType objType);

Parameters:

  • objType - salesforce SObject name

Return Value:

Field names list


getAllFields(String objType)

Returns all SObject fields

Signature:

forvendi.BreezzApi.DESCRIBE.getAllFields(String objType);

Parameters:

  • objType - salesforce SObject name

Return Value:

Field names list


getDescribe(SObjectType objType)

Returns selected object DescribeSObjectResult

Signature:

forvendi.BreezzApi.DESCRIBE.getDescribe(SObjectType objType);

Parameters:

  • objType - salesforce SObject name

Return Value:

DescribeSObjectResult instance


getDescribe(String objType)

Returns selected object DescribeSObjectResult

Signature:

forvendi.BreezzApi.DESCRIBE.getDescribe(String objType);

Parameters:

  • objType - salesforce SObject name

Return Value:

DescribeSObjectResult instance


getFieldDescribe(SObjectType objType, String field)

Returns selected field DescribeFieldResult

Signature:

forvendi.BreezzApi.DESCRIBE.getFieldDescribe(SObjectType objType, String field);

Parameters:

  • objType - salesforce SObject name
  • field - salesforce SObject field name

Return Value:

DescribeFieldResult instance


getFieldDescribe(String objType, String field)

Returns selected field DescribeFieldResult

Signature:

forvendi.BreezzApi.DESCRIBE.getFieldDescribe(String objType, String field);

Parameters:

  • objType - salesforce SObject name
  • field - salesforce SObject field name

Return Value:

DescribeFieldResult instance


createInstance(String className)

Creates class instance base on the class name

Signature:

forvendi.BreezzApi.DESCRIBE.createInstance(String className);

Parameters:

  • className - salesforce class or SObject name

Return Value:

Converted List