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. For example, inbound label.
      Returns:
      the inbound relationship label of the field

    • getInboundRelationshipName

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

    • getOutboundRelationshipName

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

    • getRelationshipCriteria

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

    • getRelationshipDeleteType

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

    • getReferencedObjectName

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

    • 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. For example, ObjectDocumentReferenceFieldMetadataVersionType.LATEST_VERSION.
      Returns:
      the ObjectDocumentReferenceFieldMetadataVersionType of the field

    • isPreDefaultReference

      boolean isPreDefaultReference()
      Retrieves whether this document reference field will pre-default values (auto-populate values that users can clear or edit before saving) when only one reference document is available. Can only be used if the field is not required.

      This behavior only applies when creating or copying records on the object record details page.

      Returns:
      true if this document reference field will pre-default values, otherwise false