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

Interface ObjectDocumentReferenceFieldMetadata

All Superinterfaces:
ObjectFieldMetadata
public interface ObjectDocumentReferenceFieldMetadata extends ObjectFieldMetadata
Provides methods to retrieve common metadata on document reference fields.
See Also:

  • Method Details

    • getInboundRelationshipLabel

      String getInboundRelationshipLabel()
      Retrieves the inbound relationship label of the given document reference field.
      Returns:
      the inbound relationship label of the field. For example, "inbound label".

    • getInboundRelationshipName

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

    • getOutboundRelationshipName

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

    • getRelationshipCriteria

      String getRelationshipCriteria()
      Retrieves the relationship criteria of the given document reference field.
      Returns:
      the relationship criteria of the field. For example, "currency__c = {{this.local_currency__c}}".

    • getRelationshipDeleteType

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

    • getReferencedObjectName

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

    • allowInlineCreate

      boolean allowInlineCreate()
      Retrieves whether the document reference field allows inline create.
      Returns:
      true if the field allows inline create, otherwise false

    • isSecureRelationship

      boolean isSecureRelationship()
      Retrieves whether the document reference field is a secure relationship.
      Returns:
      true if the field is a secure relationship, otherwise false

    • getVersionType

      ObjectDocumentReferenceFieldMetadataVersionType getVersionType()
      Retrieves the ObjectDocumentReferenceFieldMetadataVersionType of the given document reference field.
      Returns:
      the ObjectDocumentReferenceFieldMetadataVersionType of the field. For example, ObjectDocumentReferenceFieldMetadataVersionType.LATEST_VERSION.