Package com.veeva.vault.sdk.api.document

Interface DocumentFieldMetadata

All Known Subinterfaces:
DocumentBooleanFieldMetadata, DocumentComponentFieldMetadata, DocumentDateFieldMetadata, DocumentDateTimeFieldMetadata, DocumentFormulaFieldMetadata, DocumentIdFieldMetadata, DocumentLookupFieldMetadata, DocumentNumberFieldMetadata, DocumentObjectReferenceFieldMetadata, DocumentPicklistFieldMetadata, DocumentRoleFieldMetadata, DocumentTextFieldMetadata, DocumentUrlFieldMetadata
public interface DocumentFieldMetadata
Provides methods to retrieve common metadata on the specified document field.
See Also:

  • Method Details

    • getName

      String getName()
      Retrieves the name of the given document field. For example, "name__v".
      Returns:
      the non-null field name

    • getLabel

      String getLabel()
      Retrieves the label value, in the current user's language, of the given document field. For example, "Name".
      Returns:
      the label value of the field

    • getHelpContent

      String getHelpContent()
      Retrieves the help content of the given document field. This help content appears in the Vault UI to assist users in creating documents. For example, "Enter the most recent result."
      Returns:
      help content specified on the field

    • getSourceType

      SourceType getSourceType()
      Retrieves the SourceType of the given object field. For example, SourceType.STANDARD.
      Returns:
      the SourceType of the field
      See Also:

    • getDocumentFieldMetadataType

      DocumentFieldMetadataType getDocumentFieldMetadataType()
      Retrieves the DocumentFieldMetadataType of the given document field. For example, DocumentFieldMetadataType.TEXT.
      Returns:
      the DocumentFieldMetadataType of the field

    • getTypedDocumentFieldMetadata

      <T extends DocumentFieldMetadata> T getTypedDocumentFieldMetadata(Class<T> metadataClass)
      Retrieves a subclass of DocumentFieldMetadata. This allows you to fetch the type field attributes of the given object field. For example, DocumentTextFieldMetadata.
      Returns:
      a subclass of DocumentFieldMetadata for the field

    • getValueType

      ValueType getValueType()
      Retrieves the ValueType of the given document field. For example, ValueType.STRING.
      Returns:
      the ValueType of the field

    • isActive

      boolean isActive()
      Retrieves the active status of the given document field.
      Returns:
      true if the field is active, otherwise false

    • isCopyField

      boolean isCopyField()
      Retrieves whether the given field is a copy field.
      Returns:
      true if the field is a copy field, otherwise false

    • isEditable

      boolean isEditable()
      Retrieves the editability of the given document field for the current user.
      Returns:
      true if the current user can edit this field, otherwise false

    • isVisible

      boolean isVisible()
      Retrieves the visibility of the given document field for the current user.
      Returns:
      true if the current user can view this field, otherwise false

    • isQueryable

      boolean isQueryable()
      Retrieves whether the given document field is queryable by VQL for the current user.
      Returns:
      true if the current user can query for this field, otherwise false

    • isRequired

      boolean isRequired()
      Retrieves the required status of the given document field.
      Returns:
      true if the field is required, otherwise false

    • isShared

      boolean isShared()
      Retrieves the shared status of the given document field.
      Returns:
      true if the field is shared, otherwise false

    • isFacetable

      boolean isFacetable()
      Retrieves whether the given object field is facetable. When true, the field is available for use as a faceted filter in the Vault UI.
      Returns:
      true if the field is facetable, otherwise false