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

Interface ObjectFormulaNumberFieldMetadata

All Superinterfaces:
ObjectFormulaFieldTypeMetadata
public interface ObjectFormulaNumberFieldMetadata extends ObjectFormulaFieldTypeMetadata
Provides methods to retrieve common metadata on number formula fields.
See Also:

  • Method Details

    • getMaximumValue

      BigDecimal getMaximumValue()
      Retrieves the maximum value of the given number formula field.
      Returns:
      the maximum value of the field. For example, 100.

    • getMinimumValue

      BigDecimal getMinimumValue()
      Retrieves the minimum value of the given number formula field.
      Returns:
      the minimum value of the field. For example, 1.

    • getScale

      int getScale()
      Retrieves the scale of the given number formula field.
      Returns:
      the scale of the field. For example, 1.

    • getFormatMask

      FormatMaskExpressionMetadata getFormatMask()
      Retrieves the FormatMaskExpressionMetadata containing the format mask expression of the given number formula field.
      Returns:
      a FormatMaskExpressionMetadata with the format mask expression if it exists, otherwise null