Skip to main content
[ This file is autogenerated from apexdoc ]

AqObjectMapping

Represents a single object's mapping configuration. Provides access to field definitions, external ID information, and child object mappings.

Group modules/mapping tool

Overview​

AqObjectMapping encapsulates the mapping configuration for a single Salesforce object, including all field definitions and child object relationships. This class is the primary interface for programmatically accessing field mappings.

Key Capabilities​

  • Get field definitions by Salesforce field name or external field name
  • Access external ID field configuration
  • Retrieve child object definitions by plural name
  • Bidirectional field name mapping utilities

Usage​

Typically obtained through AqMappingConfigurationWrapper:

AqMappingConfigurationWrapper config = new AqMappingConfigurationWrapper(
new AqFieldDefinitionMappingData(),
new AqObjectDefinitionMappingData()
);

AqObjectMapping objectMapping = config.getObjectMapping('AccountMapping');

See the main module documentation for detailed examples of field mapping utilities.

Constructors​

public AqObjectMapping(ObjectDefinitionMapping__mdt objectDefinition, List<FieldDefinitionMapping__mdt> fieldDefinitions, List<ObjectDefinitionMapping__mdt> childObjectDefinitions)​


Fields​

public ERROR_MESSAGE_PARENT_ID_NOT_SPECIFIED → String​

public ERROR_MESSAGE_DUPLICATE_EXTERNAL_NAME → String​

public ERROR_MESSAGE_DUPLICATE_EXTERNAL_IDS → String​

public ERROR_MESSAGE_DUPLICATE_SF_FIELDS → String​

public ERROR_MESSAGE_RELATIONSHIP_WITH_FIELD_DEFINITION → String​


Methods​

public FieldDefinitionMapping__mdt getFieldDefinition(String fieldName)​

public Map<String,FieldDefinitionMapping__mdt> getFieldDefinitionByExternalName()​

public FieldDefinitionMapping__mdt getExternalIdFieldDefinition()​

public ObjectDefinitionMapping__mdt getObjectDefinition()​

public Map<String,ObjectDefinitionMapping__mdt> getChildDefinitionsByPluralName()​