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

Interface ObjectFieldMetadata

All Known Subinterfaces:
ObjectAttachmentFieldMetadata, ObjectBooleanFieldMetadata, ObjectComponentFieldMetadata, ObjectCurrencyFieldMetadata, ObjectDateFieldMetadata, ObjectDateTimeFieldMetadata, ObjectDocumentReferenceFieldMetadata, ObjectEmailFieldMetadata, ObjectFormulaFieldMetadata, ObjectIdFieldMetadata, ObjectLinkFieldMetadata, ObjectLongTextFieldMetadata, ObjectLookupFieldMetadata, ObjectNumberFieldMetadata, ObjectParentReferenceFieldMetadata, ObjectPercentFieldMetadata, ObjectPhoneFieldMetadata, ObjectPicklistFieldMetadata, ObjectReferenceFieldMetadata, ObjectRichTextFieldMetadata, ObjectTextFieldMetadata, ObjectTimeFieldMetadata, ObjectUnboundDocumentFieldMetadata
public interface ObjectFieldMetadata
Provides methods to retrieve common metadata on the specified object field.
See Also:

  • Method Details

    • getName

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

    • getLabel

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

    • getCreatedByUserId

      String getCreatedByUserId()
      Retrieves the user that created the given object field. For example, "1000001".
      Returns:
      the ID of the user who created the field

    • getCreatedDate

      ZonedDateTime getCreatedDate()
      Retrieves the date that the given object field was created. For example, 2023-04-11T18:54:01.000Z.
      Returns:
      the date that the field was created

    • getModifiedByUserId

      String getModifiedByUserId()
      Retrieves the most recent user that modified the given object field. For example, "1000001".
      Returns:
      the ID of the most recent user who modified the field

    • getModifiedDate

      ZonedDateTime getModifiedDate()
      Retrieves the date that the given object field was last modified. For example, 2023-04-11T18:54:01.000Z.
      Returns:
      the date that the field was last modified

    • getHelpContent

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

    • getObjectName

      String getObjectName()
      Retrieves the object name of the given object field. For example, "study__v".
      Returns:
      the name of the object this field is associated with

    • getOrder

      int getOrder()
      Retrieves the display order of the given object field. For example, 1.
      Returns:
      the display order of 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:

    • isActive

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

    • isEditable

      boolean isEditable()
      Retrieves whether the given object field is editable.
      Returns:
      true if the field is editable, 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

    • isListColumn

      boolean isListColumn()
      Retrieves whether the given object field is a list column.
      Returns:
      true if the field is a list column, otherwise false

    • isRequired

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

    • isUnique

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

    • getValueType

      ValueType getValueType()
      Retrieves the ValueType of the given object field. For example, ValueType.NUMBER.
      Returns:
      the non-null ValueType
      See Also:

    • getObjectFieldMetadataType

      ObjectFieldMetadataType getObjectFieldMetadataType()
      Retrieves the ObjectFieldMetadataType of the given object field. For example, ObjectFieldMetadataType.TEXT.
      Returns:
      the ObjectFieldMetadataType of the field
      See Also:

    • getTypedObjectFieldMetadata

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

    • isCopyField

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

    • isEncrypted

      boolean isEncrypted()
      Retrieves whether the given field is encrypted.
      Returns:
      true if the field is encrypted, otherwise false

    • getDescription

      String getDescription()
      Retrieves the description of the given object field. This description appears in the Admin UI to assist in object configuration and is not visible to users. For example, "Used when users select records in a dropdown."
      Returns:
      description specified on the field