Package com.veeva.vault.sdk.api.data

Interface ObjectLookupParentReferenceFieldMetadata

All Superinterfaces:
ObjectLookupFieldTypeMetadata
public interface ObjectLookupParentReferenceFieldMetadata extends ObjectLookupFieldTypeMetadata
Provides methods to retrieve common metadata on parent reference lookup fields.
See Also:

  • Method Details

    • getInboundRelationshipLabel

      String getInboundRelationshipLabel()
      Retrieves the inbound relationship label (relationship_inbound_label) of the given parent reference lookup field. For example, inbound label.
      Returns:
      the inbound relationship label of the field

    • getInboundRelationshipName

      String getInboundRelationshipName()
      Retrieves the inbound relationship name (relationship_inbound_name) of the given parent reference lookup field. For example, inbound__cr.
      Returns:
      the inbound relationship name of the field

    • getOutboundRelationshipName

      String getOutboundRelationshipName()
      Retrieves the outbound relationship name (relationship_outbound_name) of the given parent reference lookup field. For example, outbound__cr.
      Returns:
      the outbound relationship name of the field

    • getReferencedObjectName

      String getReferencedObjectName()
      Retrieves the referenced object name (object) of the given parent reference lookup field. For example, referenced_obj__c.
      Returns:
      the referenced object name of the field

    • getRelationshipDeleteType

      ObjectReferenceFieldMetadataDeleteType getRelationshipDeleteType()
      Retrieves the ObjectReferenceFieldMetadataDeleteType (relationship_deletion) of the given parent reference lookup field. For example, ObjectReferenceFieldMetadataDeleteType.BLOCK.
      Returns:
      the ObjectReferenceFieldMetadataDeleteType of the field if it exists, otherwise null