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

Interface ObjectField

public interface ObjectField
Deprecated.
as of 23R1.3, see ObjectMetadataService.getField(ObjectFieldRequest)
Provides methods to retrieve common metadata information of the specified object field.
See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    ObjectFieldType
    getFieldType()
    Deprecated.
    Retrieves the ObjectFieldType of the given object field.
    String
    getLabel()
    Deprecated.
    Retrieves the label value, in the current user's language, of the given object field.
    String
    getName()
    Deprecated.
    Retrieves the name of the given object field.
    ValueType
    getValueType()
    Deprecated.
    Retrieves the ValueType of the given object field.
    boolean
    isActive()
    Deprecated.
    Retrieves the active status of the given object field.
    boolean
    isCopyField()
    Deprecated.
    Retrieves the copyable status of the given object field.
    boolean
    isEditable()
    Deprecated.
    Retrieves the editable status of the given object field.
    boolean
    isEncrypted()
    Deprecated.
    Retrieves the encryption status of the given object field.
    boolean
    isRequired()
    Deprecated.
    Retrieves the required status of the given object field.
    boolean
    isUnique()
    Deprecated.
    Retrieves the unique status of the given object field.

  • Method Details

    • getName

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

    • getLabel

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

    • isActive

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

    • isRequired

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

    • isUnique

      boolean isUnique()
      Deprecated.
      Retrieves the unique status of the given object field.
      Returns:
      true if the field is unique, otherwise false

    • isEditable

      boolean isEditable()
      Deprecated.
      Retrieves the editable status of the given object field.
      Returns:
      true if the field is editable, otherwise false

    • isCopyField

      boolean isCopyField()
      Deprecated.
      Retrieves the copyable status of the given object field.
      Returns:
      true if the field is copyable, otherwise false

    • isEncrypted

      boolean isEncrypted()
      Deprecated.
      Retrieves the encryption status of the given object field.
      Returns:
      true if the the field is encrypted, otherwise false

    • getValueType

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

    • getFieldType

      ObjectFieldType getFieldType()
      Deprecated.
      Retrieves the ObjectFieldType of the given object field.
      Returns:
      the non-null ObjectFieldType. For example, ObjectFieldType.NUMBER